@aws-sdk/client-s3

/// <reference types="node" /> 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"; export interface PutObjectRetentionOutput { /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the Amazon S3 User Guide. * Note: 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requester Pays Buckets</a> in the Amazon S3 User Guide. */ 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 <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. */ 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; } export interface PutObjectTaggingOutput { /** * The versionId of the object the tag-set was added to. */ VersionId?: string; } export interface PutObjectTaggingRequest { /** * The bucket name containing the object. * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the Amazon S3 User Guide. * When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the Amazon S3 User Guide. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues */ 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; /** * 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 <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. */ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** * Container for the <code>TagSet</code> and <code>Tag</code> 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; /** * Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. For information about downloading * objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requester Pays Buckets</a> in the Amazon S3 User Guide. */ RequestPayer?: RequestPayer | string; } export interface PutPublicAccessBlockRequest { /** * The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration 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 */ Bucket: string | undefined; /** * The MD5 hash of the <code>PutPublicAccessBlock</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. */ 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 <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. */ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** * The <code>PublicAccessBlock</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; } /** * 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<ObjectAlreadyInActiveTierError, __BaseException>); } 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; } export declare enum Tier { Bulk = "Bulk", Expedited = "Expedited", Standard = "Standard" } /** * Container for S3 Glacier job parameters. */ export interface GlacierJobParameters { /** * Retrieval tier at which the restore will be processed. */ Tier: Tier | string | undefined; } /** * 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 <code>aws:kms</code>, this optional value specifies the ID of * the symmetric customer managed key to use for encryption of job results. Amazon S3 only * supports symmetric keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and * asymmetric keys</a> in the Amazon Web Services Key Management Service Developer * Guide. */ KMSKeyId?: string; /** * If the encryption type is <code>aws:kms</code>, this optional value can be used to * specify the encryption context for the restore results. */ KMSContext?: string; } /** * 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; } /** * 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; } /** * 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; } export declare enum ExpressionType { SQL = "SQL" } export declare enum CompressionType { BZIP2 = "BZIP2", GZIP = "GZIP", NONE = "NONE" } export declare enum FileHeaderInfo { IGNORE = "IGNORE", NONE = "NONE", USE = "USE" } /** * 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: * <ul> * <li> * * <code>NONE</code>: First line is not a header. * </li> * <li> * * <code>IGNORE</code>: 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 (<code>SELECT s._1 FROM OBJECT s</code>). * </li> * <li> * * <code>Use</code>: First line is a header, and you can use the header value to * identify a column in an expression (<code>SELECT "name" FROM OBJECT</code>). * </li> * </ul> */ 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. */ Comments?: string; /** * A single character used for escaping the quotation mark character inside an already * escaped value. For example, the value <code>""" a , b """</code> is parsed as <code>" a , b * "</code>. */ 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 <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, * as follows: <code>" a , b "</code>. * Type: String * Default: <code>"</code> * * Ancestors: <code>CSV</code> * */ 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; } export declare enum JSONType { DOCUMENT = "DOCUMENT", LINES = "LINES" } /** * Specifies JSON as object's input serialization format. */ export interface JSONInput { /** * The type of JSON. Valid values: Document, Lines. */ Type?: JSONType | string; } /** * Container for Parquet. */ export interface ParquetInput { } /** * 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; } export declare enum QuoteFields { ALWAYS = "ALWAYS", ASNEEDED = "ASNEEDED" } /** * Describes how uncompressed comma-separated values (CSV)-formatted results are * formatted. */ export interface CSVOutput { /** * Indicates whether to use quotation marks around output fields. * <ul> * <li> * * <code>ALWAYS</code>: Always use quotation marks for output fields. * </li> * <li> * * <code>ASNEEDED</code>: Use quotation marks for output fields when needed. * </li> * </ul> */ 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; /** * A single character used for escaping when the field delimiter is part of the value. For * example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, * as follows: <code>" a , b "</code>. */ QuoteCharacter?: string; } /** * 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; } /** * 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; } /** * 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; } export declare enum RestoreRequestType { SELECT = "SELECT" } /** * Container for restore job parameters. */ export interface RestoreRequest { /** * Lifetime of the active copy in days. Do not use with restores that specify * <code>OutputLocation</code>. * 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 <code>OutputLocation</code>. */ 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; } export interface RestoreObjectRequest { /** * The bucket name containing the object to restore. * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the Amazon S3 User Guide. * When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the Amazon S3 User Guide. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues */ 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; /** * Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. For information about downloading * objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requester Pays Buckets</a> in the Amazon S3 User Guide. */ RequestPayer?: RequestPayer | 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 <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. */ 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; } /** * */ export interface ContinuationEvent { } /** * 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 * <code>EndEvent</code>. */ export interface EndEvent { } /** * 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; } /** * This data type contains information about the progress event of an operation. */ export interface ProgressEvent { /** * The Progress event details. */ Details?: Progress; } /** * The container for the records event. */ export interface RecordsEvent { /** * The byte array of partial, one or more result records. */ Payload?: Uint8Array; } /** * 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; } /** * Container for the Stats Event. */ export interface StatsEvent { /** * The Stats event details. */ Details?: Stats; } /** * The container for selecting objects from a content event stream. */ export declare type SelectObjectContentEventStream = SelectObjectContentEventStream.ContMember | SelectObjectContentEventStream.EndMember | SelectObjectContentEventStream.ProgressMember | SelectObjectContentEventStream.RecordsMember | SelectObjectContentEventStream.StatsMember | SelectObjectContentEventStream.$UnknownMember; 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<T> { 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: <T>(value: SelectObjectContentEventStream, visitor: Visitor<T>) => T; } export interface SelectObjectContentOutput { /** * The array of results. */ Payload?: AsyncIterable<SelectObjectContentEventStream>; } /** * Container for specifying if periodic <code>QueryProgress</code> messages should be * sent. */ export interface RequestProgress { /** * Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, * FALSE. Default value: FALSE. */ Enabled?: boolean; } /** * 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 <code>start</code> is supplied, it * means scan from that point to the end of the file. For example, * <code><scanrange><start>50</start></scanrange></code> 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, * <code><scanrange><end>50</end></scanrange></code> means scan the * last 50 bytes. */ End?: number; } /** * 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 * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html">S3Select API Documentation</a>. */ export interface SelectObjectContentRequest { /** * The S3 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 */ 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the * Amazon S3 User Guide. */ SSECustomerAlgorithm?: string; /** * The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. * For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the * Amazon S3 User Guide. */ SSECustomerKey?: string; /** * The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum * algorithm. For more information, * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the * Amazon S3 User Guide. */ 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; /** * 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. * * <code>ScanRange</code>may be used in the following ways: * <ul> * <li> * * <code><scanrange><start>50</start><end>100</end></scanrange></code> * - process only the records starting between the bytes 50 and 100 (inclusive, counting * from zero) * </li> * <li> * * <code><scanrange><start>50</start></scanrange></code> - * process only the records starting after the byte 50 * </li> * <li> * * <code><scanrange><end>50</end></scanrange></code> - * process only the records within the last 50 bytes of the file. * </li> * </ul> */ 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; } 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 <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. */ 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 <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. */ 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 <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. */ 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 <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. */ 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 Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric * 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 Amazon Web Services KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export interface UploadPartRequest { /** * Object data. */ Body?: Readable | ReadableStream | Blob; /** * The name of the bucket to which the multipart upload was initiated. * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the Amazon S3 User Guide. * When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the Amazon S3 User Guide. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues */ 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; /** * 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 <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. * This checksum algorithm must be the same for all parts and it match the checksum * value supplied in the <code>CreateMultipartUpload</code> 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 * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> 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 * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> 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 * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> 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 * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> 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 * <code>x-amz-server-side-encryption-customer-algorithm header</code>. 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; /** * Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. For information about downloading * objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requester Pays Buckets</a> in the Amazon S3 User Guide. */ 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; } /** * 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; /** * 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 <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. */ 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 <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. */ 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 <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. */ ChecksumSHA1?: string; /** * The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present