/// import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client"; import { Readable } from "stream"; import { ChecksumAlgorithm, Grant, ObjectCannedACL, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetention, PublicAccessBlockConfiguration, ReplicationStatus, RequestCharged, RequestPayer, ServerSideEncryption, StorageClass, Tagging } from "./models_0"; import { S3ServiceException as __BaseException } from "./S3ServiceException"; /** * @public */ export interface PutObjectRetentionOutput { /** *

If present, indicates that the requester was successfully charged for the * request.

*/ RequestCharged?: RequestCharged | string; } /** * @public */ export interface PutObjectRetentionRequest { /** *

The bucket name that contains the object you want to apply this Object Retention * configuration to.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

*/ Bucket: string | undefined; /** *

The key name for the object that you want to apply this Object Retention configuration * to.

*/ Key: string | undefined; /** *

The container element for the Object Retention configuration.

*/ Retention?: ObjectLockRetention; /** *

Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. For information about downloading * objects from Requester Pays buckets, see Downloading Objects in * Requester Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; /** *

The version ID for the object that you want to apply this Object Retention configuration * to.

*/ VersionId?: string; /** *

Indicates whether this action should bypass Governance-mode restrictions.

*/ BypassGovernanceRetention?: boolean; /** *

The MD5 hash for 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.

*/ ContentMD5?: string; /** *

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any * additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or * x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more * information, see Checking object integrity in * the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** *

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedBucketOwner?: string; } /** * @public */ export interface PutObjectTaggingOutput { /** *

The versionId of the object the tag-set was added to.

*/ VersionId?: string; } /** * @public */ export interface PutObjectTaggingRequest { /** *

The bucket name containing the object.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

*/ Bucket: string | undefined; /** *

Name of the object key.

*/ Key: string | undefined; /** *

The versionId of the object that the tag-set will be added to.

*/ VersionId?: string; /** *

The MD5 hash for 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.

*/ ContentMD5?: string; /** *

If you provide an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** *

Container for the TagSet and Tag elements

*/ Tagging: Tagging | undefined; /** *

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedBucketOwner?: string; /** *

*/ RequestPayer?: RequestPayer | string; } /** * @public */ export interface PutPublicAccessBlockRequest { /** *

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want * to set.

*/ Bucket: string | undefined; /** *

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

*/ ContentMD5?: string; /** *

If you provide an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** *

The PublicAccessBlock configuration that you want to apply to this Amazon S3 * bucket. You can enable the configuration options in any combination. For more information * about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

*/ PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined; /** *

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedBucketOwner?: string; } /** * @public *

This action is not allowed against this storage tier.

*/ export declare class ObjectAlreadyInActiveTierError extends __BaseException { readonly name: "ObjectAlreadyInActiveTierError"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType); } /** * @public */ export interface RestoreObjectOutput { /** *

If present, indicates that the requester was successfully charged for the * request.

*/ RequestCharged?: RequestCharged | string; /** *

Indicates the path in the provided S3 output location where Select results will be * restored to.

*/ RestoreOutputPath?: string; } /** * @public * @enum */ export declare const Tier: { readonly Bulk: "Bulk"; readonly Expedited: "Expedited"; readonly Standard: "Standard"; }; /** * @public */ export type Tier = (typeof Tier)[keyof typeof Tier]; /** * @public *

Container for S3 Glacier job parameters.

*/ export interface GlacierJobParameters { /** *

Retrieval tier at which the restore will be processed.

*/ Tier: Tier | string | undefined; } /** * @public *

Contains the type of server-side encryption used.

*/ export interface Encryption { /** *

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, * AES256, aws:kms).

*/ EncryptionType: ServerSideEncryption | string | undefined; /** *

If the encryption type is aws:kms, this optional value specifies the ID of * the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only * supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service * Developer Guide.

*/ KMSKeyId?: string; /** *

If the encryption type is aws:kms, this optional value can be used to * specify the encryption context for the restore results.

*/ KMSContext?: string; } /** * @public *

A metadata key-value pair to store with an object.

*/ export interface MetadataEntry { /** *

Name of the Object.

*/ Name?: string; /** *

Value of the Object.

*/ Value?: string; } /** * @public *

Describes an Amazon S3 location that will receive the results of the restore request.

*/ export interface S3Location { /** *

The name of the bucket where the restore results will be placed.

*/ BucketName: string | undefined; /** *

The prefix that is prepended to the restore results for this request.

*/ Prefix: string | undefined; /** *

Contains the type of server-side encryption used.

*/ Encryption?: Encryption; /** *

The canned ACL to apply to the restore results.

*/ CannedACL?: ObjectCannedACL | string; /** *

A list of grants that control access to the staged results.

*/ AccessControlList?: Grant[]; /** *

The tag-set that is applied to the restore results.

*/ Tagging?: Tagging; /** *

A list of metadata to store with the restore results in S3.

*/ UserMetadata?: MetadataEntry[]; /** *

The class of storage used to store the restore results.

*/ StorageClass?: StorageClass | string; } /** * @public *

Describes the location where the restore job's output is stored.

*/ export interface OutputLocation { /** *

Describes an S3 location that will receive the results of the restore request.

*/ S3?: S3Location; } /** * @public * @enum */ export declare const ExpressionType: { readonly SQL: "SQL"; }; /** * @public */ export type ExpressionType = (typeof ExpressionType)[keyof typeof ExpressionType]; /** * @public * @enum */ export declare const CompressionType: { readonly BZIP2: "BZIP2"; readonly GZIP: "GZIP"; readonly NONE: "NONE"; }; /** * @public */ export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType]; /** * @public * @enum */ export declare const FileHeaderInfo: { readonly IGNORE: "IGNORE"; readonly NONE: "NONE"; readonly USE: "USE"; }; /** * @public */ export type FileHeaderInfo = (typeof FileHeaderInfo)[keyof typeof FileHeaderInfo]; /** * @public *

Describes how an uncompressed comma-separated values (CSV)-formatted input object is * formatted.

*/ export interface CSVInput { /** *

Describes the first line of input. Valid values are:

*
* NONE: First line is not a header.
*
*
* IGNORE: First line is a header, but you can't use the header values * to indicate the column in an expression. You can use column position (such as _1, _2, * …) to indicate the column (SELECT s._1 FROM OBJECT s).
*
*
* Use: First line is a header, and you can use the header value to * identify a column in an expression (SELECT "name" FROM OBJECT).
*

*/ FileHeaderInfo?: FileHeaderInfo | string; /** *

A single character used to indicate that a row should be ignored when the character is * present at the start of that row. You can specify any character to indicate a comment line. * The default character is #.

Default: # *

*/ Comments?: string; /** *

A single character used for escaping the quotation mark character inside an already * escaped value. For example, the value """ a , b """ is parsed as " a , b * ".

*/ QuoteEscapeCharacter?: string; /** *

A single character used to separate individual records in the input. Instead of the * default value, you can specify an arbitrary delimiter.

*/ RecordDelimiter?: string; /** *

A single character used to separate individual fields in a record. You can specify an * arbitrary delimiter.

*/ FieldDelimiter?: string; /** *

A single character used for escaping when the field delimiter is part of the value. For * example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, * as follows: " a , b ".

Type: String

Default: " *

Ancestors: CSV *

*/ QuoteCharacter?: string; /** *

Specifies that CSV field values may contain quoted record delimiters and such records * should be allowed. Default value is FALSE. Setting this value to TRUE may lower * performance.

*/ AllowQuotedRecordDelimiter?: boolean; } /** * @public * @enum */ export declare const JSONType: { readonly DOCUMENT: "DOCUMENT"; readonly LINES: "LINES"; }; /** * @public */ export type JSONType = (typeof JSONType)[keyof typeof JSONType]; /** * @public *

Specifies JSON as object's input serialization format.

*/ export interface JSONInput { /** *

The type of JSON. Valid values: Document, Lines.

*/ Type?: JSONType | string; } /** * @public *

Container for Parquet.

*/ export interface ParquetInput { } /** * @public *

Describes the serialization format of the object.

*/ export interface InputSerialization { /** *

Describes the serialization of a CSV-encoded object.

*/ CSV?: CSVInput; /** *

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: * NONE.

*/ CompressionType?: CompressionType | string; /** *

Specifies JSON as object's input serialization format.

*/ JSON?: JSONInput; /** *

Specifies Parquet as object's input serialization format.

*/ Parquet?: ParquetInput; } /** * @public * @enum */ export declare const QuoteFields: { readonly ALWAYS: "ALWAYS"; readonly ASNEEDED: "ASNEEDED"; }; /** * @public */ export type QuoteFields = (typeof QuoteFields)[keyof typeof QuoteFields]; /** * @public *

Describes how uncompressed comma-separated values (CSV)-formatted results are * formatted.

*/ export interface CSVOutput { /** *

Indicates whether to use quotation marks around output fields.

*
* ALWAYS: Always use quotation marks for output fields.
*
*
* ASNEEDED: Use quotation marks for output fields when needed.
*

*/ QuoteFields?: QuoteFields | string; /** *

The single character used for escaping the quote character inside an already escaped * value.

*/ QuoteEscapeCharacter?: string; /** *

A single character used to separate individual records in the output. Instead of the * default value, you can specify an arbitrary delimiter.

*/ RecordDelimiter?: string; /** *

The value used to separate individual fields in a record. You can specify an arbitrary * delimiter.

*/ FieldDelimiter?: string; /** *

*/ QuoteCharacter?: string; } /** * @public *

Specifies JSON as request's output serialization format.

*/ export interface JSONOutput { /** *

The value used to separate individual records in the output. If no value is specified, * Amazon S3 uses a newline character ('\n').

*/ RecordDelimiter?: string; } /** * @public *

Describes how results of the Select job are serialized.

*/ export interface OutputSerialization { /** *

Describes the serialization of CSV-encoded Select results.

*/ CSV?: CSVOutput; /** *

Specifies JSON as request's output serialization format.

*/ JSON?: JSONOutput; } /** * @public *

Describes the parameters for Select job types.

*/ export interface SelectParameters { /** *

Describes the serialization format of the object.

*/ InputSerialization: InputSerialization | undefined; /** *

The type of the provided expression (for example, SQL).

*/ ExpressionType: ExpressionType | string | undefined; /** *

The expression that is used to query the object.

*/ Expression: string | undefined; /** *

Describes how the results of the Select job are serialized.

*/ OutputSerialization: OutputSerialization | undefined; } /** * @public * @enum */ export declare const RestoreRequestType: { readonly SELECT: "SELECT"; }; /** * @public */ export type RestoreRequestType = (typeof RestoreRequestType)[keyof typeof RestoreRequestType]; /** * @public *

Container for restore job parameters.

*/ export interface RestoreRequest { /** *

Lifetime of the active copy in days. Do not use with restores that specify * OutputLocation.

The Days element is required for regular restores, and must not be provided for select * requests.

*/ Days?: number; /** *

S3 Glacier related parameters pertaining to this job. Do not use with restores that * specify OutputLocation.

*/ GlacierJobParameters?: GlacierJobParameters; /** *

Type of restore request.

*/ Type?: RestoreRequestType | string; /** *

Retrieval tier at which the restore will be processed.

*/ Tier?: Tier | string; /** *

The optional description for the job.

*/ Description?: string; /** *

Describes the parameters for Select job types.

*/ SelectParameters?: SelectParameters; /** *

Describes the location where the restore job's output is stored.

*/ OutputLocation?: OutputLocation; } /** * @public */ export interface RestoreObjectRequest { /** *

The bucket name containing the object to restore.

*/ Bucket: string | undefined; /** *

Object key for which the action was initiated.

*/ Key: string | undefined; /** *

VersionId used to reference a specific version of the object.

*/ VersionId?: string; /** *

Container for restore job parameters.

*/ RestoreRequest?: RestoreRequest; /** *

*/ RequestPayer?: RequestPayer | string; /** *

If you provide an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** *

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedBucketOwner?: string; } /** * @public *

*/ export interface ContinuationEvent { } /** * @public *

A message that indicates the request is complete and no more messages will be sent. You * should not assume that the request is complete until the client receives an * EndEvent.

*/ export interface EndEvent { } /** * @public *

This data type contains information about progress of an operation.

*/ export interface Progress { /** *

The current number of object bytes scanned.

*/ BytesScanned?: number; /** *

The current number of uncompressed object bytes processed.

*/ BytesProcessed?: number; /** *

The current number of bytes of records payload data returned.

*/ BytesReturned?: number; } /** * @public *

This data type contains information about the progress event of an operation.

*/ export interface ProgressEvent { /** *

The Progress event details.

*/ Details?: Progress; } /** * @public *

The container for the records event.

*/ export interface RecordsEvent { /** *

The byte array of partial, one or more result records.

*/ Payload?: Uint8Array; } /** * @public *

Container for the stats details.

*/ export interface Stats { /** *

The total number of object bytes scanned.

*/ BytesScanned?: number; /** *

The total number of uncompressed object bytes processed.

*/ BytesProcessed?: number; /** *

The total number of bytes of records payload data returned.

*/ BytesReturned?: number; } /** * @public *

Container for the Stats Event.

*/ export interface StatsEvent { /** *

The Stats event details.

*/ Details?: Stats; } /** * @public *

The container for selecting objects from a content event stream.

*/ export type SelectObjectContentEventStream = SelectObjectContentEventStream.ContMember | SelectObjectContentEventStream.EndMember | SelectObjectContentEventStream.ProgressMember | SelectObjectContentEventStream.RecordsMember | SelectObjectContentEventStream.StatsMember | SelectObjectContentEventStream.$UnknownMember; /** * @public */ export declare namespace SelectObjectContentEventStream { /** *

The Records Event.

*/ interface RecordsMember { Records: RecordsEvent; Stats?: never; Progress?: never; Cont?: never; End?: never; $unknown?: never; } /** *

The Stats Event.

*/ interface StatsMember { Records?: never; Stats: StatsEvent; Progress?: never; Cont?: never; End?: never; $unknown?: never; } /** *

The Progress Event.

*/ interface ProgressMember { Records?: never; Stats?: never; Progress: ProgressEvent; Cont?: never; End?: never; $unknown?: never; } /** *

The Continuation Event.

*/ interface ContMember { Records?: never; Stats?: never; Progress?: never; Cont: ContinuationEvent; End?: never; $unknown?: never; } /** *

The End Event.

*/ interface EndMember { Records?: never; Stats?: never; Progress?: never; Cont?: never; End: EndEvent; $unknown?: never; } interface $UnknownMember { Records?: never; Stats?: never; Progress?: never; Cont?: never; End?: never; $unknown: [string, any]; } interface Visitor { Records: (value: RecordsEvent) => T; Stats: (value: StatsEvent) => T; Progress: (value: ProgressEvent) => T; Cont: (value: ContinuationEvent) => T; End: (value: EndEvent) => T; _: (name: string, value: any) => T; } const visit: (value: SelectObjectContentEventStream, visitor: Visitor) => T; } /** * @public */ export interface SelectObjectContentOutput { /** *

The array of results.

*/ Payload?: AsyncIterable; } /** * @public *

Container for specifying if periodic QueryProgress messages should be * sent.

*/ export interface RequestProgress { /** *

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, * FALSE. Default value: FALSE.

*/ Enabled?: boolean; } /** * @public *

Specifies the byte range of the object to get the records from. A record is processed * when its first byte is contained by the range. This parameter is optional, but when * specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the * start and end of the range.

*/ export interface ScanRange { /** *

Specifies the start of the byte range. This parameter is optional. Valid values: * non-negative integers. The default value is 0. If only start is supplied, it * means scan from that point to the end of the file. For example, * 50 means scan * from byte 50 until the end of the file.

*/ Start?: number; /** *

Specifies the end of the byte range. This parameter is optional. Valid values: * non-negative integers. The default value is one less than the size of the object being * queried. If only the End parameter is supplied, it is interpreted to mean scan the last N * bytes of the file. For example, * 50 means scan the * last 50 bytes.

*/ End?: number; } /** * @public *

Request to filter the contents of an Amazon S3 object based on a simple Structured Query * Language (SQL) statement. In the request, along with the SQL expression, you must specify a * data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data * into records. It returns only records that match the specified SQL expression. You must * also specify the data serialization format for the response. For more information, see * S3Select API Documentation.

*/ export interface SelectObjectContentRequest { /** *

The S3 bucket.

*/ Bucket: string | undefined; /** *

The object key.

*/ Key: string | undefined; /** *

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created * using a checksum algorithm. For more information, * see Protecting data using SSE-C keys in the * Amazon S3 User Guide.

*/ SSECustomerAlgorithm?: string; /** *

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. * For more information, see * Protecting data using SSE-C keys in the * Amazon S3 User Guide.

*/ SSECustomerKey?: string; /** *

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum * algorithm. For more information, * see Protecting data using SSE-C keys in the * Amazon S3 User Guide.

*/ SSECustomerKeyMD5?: string; /** *

The expression that is used to query the object.

*/ Expression: string | undefined; /** *

The type of the provided expression (for example, SQL).

*/ ExpressionType: ExpressionType | string | undefined; /** *

Specifies if periodic request progress information should be enabled.

*/ RequestProgress?: RequestProgress; /** *

Describes the format of the data in the object that is being queried.

*/ InputSerialization: InputSerialization | undefined; /** *

Describes the format of the data that you want Amazon S3 to return in response.

*/ OutputSerialization: OutputSerialization | undefined; /** *

* ScanRangemay be used in the following ways:

*
* 50100 * - process only the records starting between the bytes 50 and 100 (inclusive, counting * from zero)
*
*
* 50 - * process only the records starting after the byte 50
*
*
* 50 - * process only the records within the last 50 bytes of the file.
*

*/ ScanRange?: ScanRange; /** *

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedBucketOwner?: string; } /** * @public */ export interface UploadPartOutput { /** *

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, * AES256, aws:kms).

*/ ServerSideEncryption?: ServerSideEncryption | string; /** *

Entity tag for the uploaded object.

*/ ETag?: string; /** *

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see * Checking object integrity in the Amazon S3 User Guide.

*/ ChecksumCRC32?: string; /** *

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see * Checking object integrity in the Amazon S3 User Guide.

*/ ChecksumCRC32C?: string; /** *

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see * Checking object integrity in the Amazon S3 User Guide.

*/ ChecksumSHA1?: string; /** *

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see * Checking object integrity in the Amazon S3 User Guide.

*/ ChecksumSHA256?: string; /** *

If server-side encryption with a customer-provided encryption key was requested, the * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

If server-side encryption with a customer-provided encryption key was requested, the * response will include this header to provide round-trip message integrity verification of * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key * was used for the object.

*/ SSEKMSKeyId?: string; /** *

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption * with Key Management Service (KMS) keys (SSE-KMS).

*/ BucketKeyEnabled?: boolean; /** *

If present, indicates that the requester was successfully charged for the * request.

*/ RequestCharged?: RequestCharged | string; } /** * @public */ export interface UploadPartRequest { /** *

Object data.

*/ Body?: Readable | ReadableStream | Blob; /** *

The name of the bucket to which the multipart upload was initiated.

*/ Bucket: string | undefined; /** *

Size of the body in bytes. This parameter is useful when the size of the body cannot be * determined automatically.

*/ ContentLength?: number; /** *

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated * when using the command from the CLI. This parameter is required if object lock parameters * are specified.

*/ ContentMD5?: string; /** *

If you provide an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value * supplied in the CreateMultipartUpload request.

*/ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** *

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. * This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see * Checking object integrity in the * Amazon S3 User Guide.

*/ ChecksumCRC32?: string; /** *

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. * This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see * Checking object integrity in the * Amazon S3 User Guide.

*/ ChecksumCRC32C?: string; /** *

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. * This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see * Checking object integrity in the * Amazon S3 User Guide.

*/ ChecksumSHA1?: string; /** *

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. * This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see * Checking object integrity in the * Amazon S3 User Guide.

*/ ChecksumSHA256?: string; /** *

Object key for which the multipart upload was initiated.

*/ Key: string | undefined; /** *

Part number of part being uploaded. This is a positive integer between 1 and * 10,000.

*/ PartNumber: number | undefined; /** *

Upload ID identifying the multipart upload whose part is being uploaded.

*/ UploadId: string | undefined; /** *

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

*/ SSECustomerAlgorithm?: string; /** *

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This * value is used to store the object and then it is discarded; Amazon S3 does not store the * encryption key. The key must be appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header. This must be the * same encryption key specified in the initiate multipart upload request.

*/ SSECustomerKey?: string; /** *

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses * this header for a message integrity check to ensure that the encryption key was transmitted * without error.

*/ SSECustomerKeyMD5?: string; /** *

*/ RequestPayer?: RequestPayer | string; /** *

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedBucketOwner?: string; } /** * @public *

Container for all response elements.

*/ export interface CopyPartResult { /** *

Entity tag of the object.

*/ ETag?: string; /** *

Date and time at which the object was uploaded.

*/ LastModified?: Date; /** *

*/ ChecksumCRC32?: string; /** *

*/ ChecksumCRC32C?: string; /** *

*/ ChecksumSHA1?: string; /** *

*/ ChecksumSHA256?: string; } /** * @public */ export interface UploadPartCopyOutput { /** *

The version of the source object that was copied, if you have enabled versioning on the * source bucket.

*/ CopySourceVersionId?: string; /** *

Container for all response elements.

*/ CopyPartResult?: CopyPartResult; /** *

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, * AES256, aws:kms).

*/ ServerSideEncryption?: ServerSideEncryption | string; /** *

If server-side encryption with a customer-provided encryption key was requested, the * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key * that was used for the object.

*/ SSEKMSKeyId?: string; /** *

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption * with Key Management Service (KMS) keys (SSE-KMS).

*/ BucketKeyEnabled?: boolean; /** *

If present, indicates that the requester was successfully charged for the * request.

*/ RequestCharged?: RequestCharged | string; } /** * @public */ export interface UploadPartCopyRequest { /** *

The bucket name.

*/ Bucket: string | undefined; /** *

Specifies the source object for the copy operation. You specify the value in one of two * formats, depending on whether you want to access the source object through an access point:

*
For objects not accessed through an access point, specify the name of the source bucket * and key of the source object, separated by a slash (/). For example, to copy the * object reports/january.pdf from the bucket * awsexamplebucket, use awsexamplebucket/reports/january.pdf. * The value must be URL-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:::accesspoint//object/. 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 Amazon Web Services Region.
* *
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. 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= * to the value (for example, * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). * If you don't specify a version ID, Amazon S3 copies the latest version of the source * object.

*/ CopySource: string | undefined; /** *

Copies the object if its entity tag (ETag) matches the specified tag.

*/ CopySourceIfMatch?: string; /** *

Copies the object if it has been modified since the specified time.

*/ CopySourceIfModifiedSince?: Date; /** *

Copies the object if its entity tag (ETag) is different than the specified ETag.

*/ CopySourceIfNoneMatch?: string; /** *

Copies the object if it hasn't been modified since the specified time.

*/ CopySourceIfUnmodifiedSince?: Date; /** *

The range of bytes to copy from the source object. The range value must use the form * bytes=first-last, where the first and last are the zero-based byte offsets to copy. For * example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You * can copy a range only if the source object is greater than 5 MB.

*/ CopySourceRange?: string; /** *

Object key for which the multipart upload was initiated.

*/ Key: string | undefined; /** *

Part number of part being copied. This is a positive integer between 1 and * 10,000.

*/ PartNumber: number | undefined; /** *

Upload ID identifying the multipart upload whose part is being copied.

*/ UploadId: string | undefined; /** *

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

*/ SSECustomerAlgorithm?: string; /** *

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This * value is used to store the object and then it is discarded; Amazon S3 does not store the * encryption key. The key must be appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header. This must be the * same encryption key specified in the initiate multipart upload request.

*/ SSECustomerKey?: string; /** *

*/ SSECustomerKeyMD5?: string; /** *

Specifies the algorithm to use when decrypting the source object (for example, * AES256).

*/ CopySourceSSECustomerAlgorithm?: string; /** *

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source * object. The encryption key provided in this header must be one that was used when the * source object was created.

*/ CopySourceSSECustomerKey?: string; /** *

*/ CopySourceSSECustomerKeyMD5?: string; /** *

*/ RequestPayer?: RequestPayer | string; /** *

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedBucketOwner?: string; /** *

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

*/ ExpectedSourceBucketOwner?: string; } /** * @public */ export interface WriteGetObjectResponseRequest { /** *

Route prefix to the HTTP URL generated.

*/ RequestRoute: string | undefined; /** *

A single use encrypted token that maps WriteGetObjectResponse to the end * user GetObject request.

*/ RequestToken: string | undefined; /** *

The object data.

*/ Body?: Readable | ReadableStream | Blob; /** *

The integer status code for an HTTP response of a corresponding GetObject * request. The following is a list of status codes.

*
* 200 - OK *
*
*
* 206 - Partial Content *
*
*
* 304 - Not Modified *
*
*
* 400 - Bad Request *
*
*
* 401 - Unauthorized *
*
*
* 403 - Forbidden *
*
*
* 404 - Not Found *
*
*
* 405 - Method Not Allowed *
*
*
* 409 - Conflict *
*
*
* 411 - Length Required *
*
*
* 412 - Precondition Failed *
*
*
* 416 - Range Not Satisfiable *
*
*
* 500 - Internal Server Error *
*
*
* 503 - Service Unavailable *
*

*/ StatusCode?: number; /** *

A string that uniquely identifies an error condition. Returned in the tag * of the error XML response for a corresponding GetObject call. Cannot be used * with a successful StatusCode header or when the transformed object is provided * in the body. All error codes from S3 are sentence-cased. The regular expression (regex) * value is "^[A-Z][a-zA-Z]+$".


     */
    ErrorCode?: string;
    /**
     * Contains a generic description of the error condition. Returned in the 
     *          tag of the error XML response for a corresponding GetObject call. Cannot be
     *          used with a successful StatusCode header or when the transformed object is
     *          provided in body.
     */
    ErrorMessage?: string;
    /**
     * Indicates that a range of bytes was specified.
     */
    AcceptRanges?: string;
    /**
     * Specifies caching behavior along the request/reply chain.
     */
    CacheControl?: string;
    /**
     * Specifies presentational information for the object.
     */
    ContentDisposition?: string;
    /**
     * Specifies what content encodings have been applied to the object and thus what decoding
     *          mechanisms must be applied to obtain the media-type referenced by the Content-Type header
     *          field.
     */
    ContentEncoding?: string;
    /**
     * The language the content is in.
     */
    ContentLanguage?: string;
    /**
     * The size of the content body in bytes.
     */
    ContentLength?: number;
    /**
     * The portion of the object returned in the response.
     */
    ContentRange?: string;
    /**
     * A standard MIME type describing the format of the object data.
     */
    ContentType?: string;
    /**
     * This header can be used as a data integrity check to verify that the data received is
     *          the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32
     *          checksum of the object returned by the Object Lambda function. This may not match the
     *          checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
     *          only when the original GetObject request required checksum validation. For
     *          more information about checksums, see Checking object
     *             integrity in the Amazon S3 User Guide.
     *          Only one checksum header can be specified at a time. If you supply multiple checksum
     *          headers, this request will fail.
     *          
     */
    ChecksumCRC32?: string;
    /**
     * This header can be used as a data integrity check to verify that the data received is
     *          the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C
     *          checksum of the object returned by the Object Lambda function. This may not match the
     *          checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
     *          only when the original GetObject request required checksum validation. For
     *          more information about checksums, see Checking object
     *             integrity in the Amazon S3 User Guide.
     *          Only one checksum header can be specified at a time. If you supply multiple checksum
     *          headers, this request will fail.
     */
    ChecksumCRC32C?: string;
    /**
     * This header can be used as a data integrity check to verify that the data received is
     *          the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1
     *          digest of the object returned by the Object Lambda function. This may not match the
     *          checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
     *          only when the original GetObject request required checksum validation. For
     *          more information about checksums, see Checking object
     *             integrity in the Amazon S3 User Guide.
     *          Only one checksum header can be specified at a time. If you supply multiple checksum
     *          headers, this request will fail.
     */
    ChecksumSHA1?: string;
    /**
     * This header can be used as a data integrity check to verify that the data received is
     *          the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256
     *          digest of the object returned by the Object Lambda function. This may not match the
     *          checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
     *          only when the original GetObject request required checksum validation. For
     *          more information about checksums, see Checking object
     *             integrity in the Amazon S3 User Guide.
     *          Only one checksum header can be specified at a time. If you supply multiple checksum
     *          headers, this request will fail.
     */
    ChecksumSHA256?: string;
    /**
     * Specifies whether an object stored in Amazon S3 is (true) or is not
     *             (false) a delete marker. 
     */
    DeleteMarker?: boolean;
    /**
     * An opaque identifier assigned by a web server to a specific version of a resource found
     *          at a URL. 
     */
    ETag?: string;
    /**
     * The date and time at which the object is no longer cacheable.
     */
    Expires?: Date;
    /**
     * If the object expiration is configured (see PUT Bucket lifecycle), the response includes
     *          this header. It includes the expiry-date and rule-id key-value
     *          pairs that provide the object expiration information. The value of the rule-id
     *          is URL-encoded. 
     */
    Expiration?: string;
    /**
     * The date and time that the object was last modified.
     */
    LastModified?: Date;
    /**
     * Set to the number of metadata entries not returned in x-amz-meta headers.
     *          This can happen if you create metadata using an API like SOAP that supports more flexible
     *          metadata than the REST API. For example, using SOAP, you can create metadata whose values
     *          are not legal HTTP headers.
     */
    MissingMeta?: number;
    /**
     * A map of metadata to store with the object in S3.
     */
    Metadata?: Record;
    /**
     * Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information
     *          about S3 Object Lock, see Object Lock.
     */
    ObjectLockMode?: ObjectLockMode | string;
    /**
     * Indicates whether an object stored in Amazon S3 has an active legal hold.
     */
    ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string;
    /**
     * The date and time when Object Lock is configured to expire.
     */
    ObjectLockRetainUntilDate?: Date;
    /**
     * The count of parts this object has.
     */
    PartsCount?: number;
    /**
     * Indicates if request involves bucket that is either a source or destination in a
     *          Replication rule. For more information about S3 Replication, see Replication.
     */
    ReplicationStatus?: ReplicationStatus | string;
    /**
     * If present, indicates that the requester was successfully charged for the
     *          request.
     */
    RequestCharged?: RequestCharged | string;
    /**
     * Provides information about object restoration operation and expiration time of the
     *          restored object copy.
     */
    Restore?: string;
    /**
     *  The server-side encryption algorithm used when storing requested object in Amazon S3 (for
     *          example, AES256, aws:kms).
     */
    ServerSideEncryption?: ServerSideEncryption | string;
    /**
     * Encryption algorithm used if server-side encryption with a customer-provided encryption
     *          key was specified for object stored in Amazon S3.
     */
    SSECustomerAlgorithm?: string;
    /**
     *  If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
     *          encryption customer managed key that was used for stored in Amazon S3 object. 
     */
    SSEKMSKeyId?: string;
    /**
     *  128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data
     *          stored in S3. For more information, see Protecting data
     *             using server-side encryption with customer-provided encryption keys
     *          (SSE-C).
     */
    SSECustomerKeyMD5?: string;
    /**
     * Provides storage class information of the object. Amazon S3 returns this header for all
     *          objects except for S3 Standard storage class objects.
     *          For more information, see Storage Classes.
     */
    StorageClass?: StorageClass | string;
    /**
     * The number of tags, if any, on the object.
     */
    TagCount?: number;
    /**
     * An ID used to reference a specific version of the object.
     */
    VersionId?: string;
    /**
     *  Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side
     *          encryption with Amazon Web Services KMS (SSE-KMS).
     */
    BucketKeyEnabled?: boolean;
}
/**
 * @internal
 */
export declare const EncryptionFilterSensitiveLog: (obj: Encryption) => any;
/**
 * @internal
 */
export declare const S3LocationFilterSensitiveLog: (obj: S3Location) => any;
/**
 * @internal
 */
export declare const OutputLocationFilterSensitiveLog: (obj: OutputLocation) => any;
/**
 * @internal
 */
export declare const RestoreRequestFilterSensitiveLog: (obj: RestoreRequest) => any;
/**
 * @internal
 */
export declare const RestoreObjectRequestFilterSensitiveLog: (obj: RestoreObjectRequest) => any;
/**
 * @internal
 */
export declare const SelectObjectContentEventStreamFilterSensitiveLog: (obj: SelectObjectContentEventStream) => any;
/**
 * @internal
 */
export declare const SelectObjectContentOutputFilterSensitiveLog: (obj: SelectObjectContentOutput) => any;
/**
 * @internal
 */
export declare const SelectObjectContentRequestFilterSensitiveLog: (obj: SelectObjectContentRequest) => any;
/**
 * @internal
 */
export declare const UploadPartOutputFilterSensitiveLog: (obj: UploadPartOutput) => any;
/**
 * @internal
 */
export declare const UploadPartRequestFilterSensitiveLog: (obj: UploadPartRequest) => any;
/**
 * @internal
 */
export declare const UploadPartCopyOutputFilterSensitiveLog: (obj: UploadPartCopyOutput) => any;
/**
 * @internal
 */
export declare const UploadPartCopyRequestFilterSensitiveLog: (obj: UploadPartCopyRequest) => any;
/**
 * @internal
 */
export declare const WriteGetObjectResponseRequestFilterSensitiveLog: (obj: WriteGetObjectResponseRequest) => any;