@aws-sdk/client-s3

import { Encryption, GlacierJobParameters, Grant, ObjectCannedACL, RequestCharged, RequestPayer, ServerSideEncryption, StorageClass, Tagging, Tier, } from "./models_0"; import { SENSITIVE_STRING } from "@aws-sdk/smithy-client"; import { Readable } from "stream"; /** * 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; } export namespace MetadataEntry { export const filterSensitiveLog = (obj: MetadataEntry): any => ({ ...obj, }); } /** * 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; } export namespace S3Location { export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, ...(obj.Encryption && { Encryption: Encryption.filterSensitiveLog(obj.Encryption) }), }); } /** * 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 namespace OutputLocation { export const filterSensitiveLog = (obj: OutputLocation): any => ({ ...obj, ...(obj.S3 && { S3: S3Location.filterSensitiveLog(obj.S3) }), }); } export type ExpressionType = "SQL"; export type CompressionType = "BZIP2" | "GZIP" | "NONE"; export 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 """ 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 <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 namespace CSVInput { export const filterSensitiveLog = (obj: CSVInput): any => ({ ...obj, }); } export 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; } export namespace JSONInput { export const filterSensitiveLog = (obj: JSONInput): any => ({ ...obj, }); } /** * Container for Parquet. */ export interface ParquetInput {} export namespace ParquetInput { export const filterSensitiveLog = (obj: ParquetInput): any => ({ ...obj, }); } /** * 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 namespace InputSerialization { export const filterSensitiveLog = (obj: InputSerialization): any => ({ ...obj, }); } export 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; } export namespace CSVOutput { export const filterSensitiveLog = (obj: CSVOutput): any => ({ ...obj, }); } /** * 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; } export namespace JSONOutput { export const filterSensitiveLog = (obj: JSONOutput): any => ({ ...obj, }); } /** * 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; } export namespace OutputSerialization { export const filterSensitiveLog = (obj: OutputSerialization): any => ({ ...obj, }); } /** * 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 namespace SelectParameters { export const filterSensitiveLog = (obj: SelectParameters): any => ({ ...obj, }); } export 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 namespace RestoreRequest { export const filterSensitiveLog = (obj: RestoreRequest): any => ({ ...obj, ...(obj.OutputLocation && { OutputLocation: OutputLocation.filterSensitiveLog(obj.OutputLocation) }), }); } export interface RestoreObjectRequest { /** * The bucket name containing the object to restore. * When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer Guide. */ Bucket: string | undefined; /** * Object key for which the operation 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 * Requestor Pays Buckets</a> in the Amazon S3 Developer Guide. */ RequestPayer?: RequestPayer | string; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace RestoreObjectRequest { export const filterSensitiveLog = (obj: RestoreObjectRequest): any => ({ ...obj, ...(obj.RestoreRequest && { RestoreRequest: RestoreRequest.filterSensitiveLog(obj.RestoreRequest) }), }); } /** * */ export interface ContinuationEvent {} export namespace ContinuationEvent { export const filterSensitiveLog = (obj: ContinuationEvent): any => ({ ...obj, }); } /** * 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 {} export namespace EndEvent { export const filterSensitiveLog = (obj: EndEvent): any => ({ ...obj, }); } /** * 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; } export namespace Progress { export const filterSensitiveLog = (obj: Progress): any => ({ ...obj, }); } /** * This data type contains information about the progress event of an operation. */ export interface ProgressEvent { /** * The Progress event details. */ Details?: Progress; } export namespace ProgressEvent { export const filterSensitiveLog = (obj: ProgressEvent): any => ({ ...obj, }); } /** * The container for the records event. */ export interface RecordsEvent { /** * The byte array of partial, one or more result records. */ Payload?: Uint8Array; } export namespace RecordsEvent { export const filterSensitiveLog = (obj: RecordsEvent): any => ({ ...obj, }); } /** * 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; } export namespace Stats { export const filterSensitiveLog = (obj: Stats): any => ({ ...obj, }); } /** * Container for the Stats Event. */ export interface StatsEvent { /** * The Stats event details. */ Details?: Stats; } export namespace StatsEvent { export const filterSensitiveLog = (obj: StatsEvent): any => ({ ...obj, }); } /** * 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; export namespace SelectObjectContentEventStream { /** * The Records Event. */ export interface RecordsMember { Records: RecordsEvent; Stats?: never; Progress?: never; Cont?: never; End?: never; $unknown?: never; } /** * The Stats Event. */ export interface StatsMember { Records?: never; Stats: StatsEvent; Progress?: never; Cont?: never; End?: never; $unknown?: never; } /** * The Progress Event. */ export interface ProgressMember { Records?: never; Stats?: never; Progress: ProgressEvent; Cont?: never; End?: never; $unknown?: never; } /** * The Continuation Event. */ export interface ContMember { Records?: never; Stats?: never; Progress?: never; Cont: ContinuationEvent; End?: never; $unknown?: never; } /** * The End Event. */ export interface EndMember { Records?: never; Stats?: never; Progress?: never; Cont?: never; End: EndEvent; $unknown?: never; } export interface $UnknownMember { Records?: never; Stats?: never; Progress?: never; Cont?: never; End?: never; $unknown: [string, any]; } export 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; } export const visit = <T>(value: SelectObjectContentEventStream, visitor: Visitor<T>): T => { if (value.Records !== undefined) return visitor.Records(value.Records); if (value.Stats !== undefined) return visitor.Stats(value.Stats); if (value.Progress !== undefined) return visitor.Progress(value.Progress); if (value.Cont !== undefined) return visitor.Cont(value.Cont); if (value.End !== undefined) return visitor.End(value.End); return visitor._(value.$unknown[0], value.$unknown[1]); }; export const filterSensitiveLog = (obj: SelectObjectContentEventStream): any => { if (obj.Records !== undefined) return { Records: RecordsEvent.filterSensitiveLog(obj.Records) }; if (obj.Stats !== undefined) return { Stats: StatsEvent.filterSensitiveLog(obj.Stats) }; if (obj.Progress !== undefined) return { Progress: ProgressEvent.filterSensitiveLog(obj.Progress) }; if (obj.Cont !== undefined) return { Cont: ContinuationEvent.filterSensitiveLog(obj.Cont) }; if (obj.End !== undefined) return { End: EndEvent.filterSensitiveLog(obj.End) }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; }; } export interface SelectObjectContentOutput { /** * The array of results. */ Payload?: AsyncIterable<SelectObjectContentEventStream>; } export namespace SelectObjectContentOutput { export const filterSensitiveLog = (obj: SelectObjectContentOutput): any => ({ ...obj, ...(obj.Payload && { Payload: "STREAMING_CONTENT" }), }); } /** * 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; } export namespace RequestProgress { export const filterSensitiveLog = (obj: RequestProgress): any => ({ ...obj, }); } /** * 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; * <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; } export namespace ScanRange { export const filterSensitiveLog = (obj: ScanRange): any => ({ ...obj, }); } /** * 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. */ Bucket: string | undefined; /** * The object key. */ Key: string | undefined; /** * The SSE Algorithm used to encrypt the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. */ SSECustomerAlgorithm?: string; /** * The SSE Customer Key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption * (Using Customer-Provided Encryption Keys</a>. */ SSECustomerKey?: string; /** * The SSE Customer Key MD5. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption * (Using Customer-Provided Encryption Keys</a>. */ 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 will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace SelectObjectContentRequest { export const filterSensitiveLog = (obj: SelectObjectContentRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_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; /** * If server-side encryption with a customer-provided encryption key was requested, the * response will include this header confirming the encryption algorithm used. */ SSECustomerAlgorithm?: string; /** * If server-side encryption with a customer-provided encryption key was requested, the * response will include this header to provide round-trip message integrity verification of * the customer-provided encryption key. */ SSECustomerKeyMD5?: string; /** * If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric * customer managed customer master key (CMK) was used for the object. */ SSEKMSKeyId?: string; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export namespace UploadPartOutput { export const filterSensitiveLog = (obj: UploadPartOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_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 API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer Guide. */ Bucket: string | undefined; /** * 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; /** * 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 * Requestor Pays Buckets</a> in the Amazon S3 Developer Guide. */ RequestPayer?: RequestPayer | string; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace UploadPartRequest { export const filterSensitiveLog = (obj: UploadPartRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_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; } export namespace CopyPartResult { export const filterSensitiveLog = (obj: CopyPartResult): any => ({ ...obj, }); } 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; /** * If server-side encryption with a customer-provided encryption key was requested, the * response will include this header to provide round-trip message integrity verification of * the customer-provided encryption key. */ SSECustomerKeyMD5?: string; /** * If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric * customer managed customer master key (CMK) that was used for the object. */ SSEKMSKeyId?: string; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export namespace UploadPartCopyOutput { export const filterSensitiveLog = (obj: UploadPartCopyOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), }); } export interface UploadPartCopyRequest { /** * The bucket name. * When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer Guide. */ Bucket: string | undefined; /** * Specifies the source object for the copy operation. You specify the value in one of two * formats, depending on whether you want to access the source object through an <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html">access * point</a>: * <ul> * <li> * For objects not accessed through an access point, specify the name of the source * bucket and key of the source object, separated by a slash (/). For example, to copy * the object <code>reports/january.pdf</code> from the bucket * <code>awsexamplebucket</code>, use * <code>awsexamplebucket/reports/january.pdf</code>. The value must be URL * encoded. * </li> * <li> * For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded. * <note> * Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region. * </note> * Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL encoded. * </li> * </ul> * To copy a specific version of an object, append <code>?versionId=<version-id></code> * to the value (for example, * <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). * If you don't specify a version ID, Amazon S3 copies the latest version of the source * object. */ CopySource: string | undefined; /** * Copies the object if its entity tag (ETag) matches the specified tag. */ CopySourceIfMatch?: string; /** * Copies the object if it has been modified since the specified time. */ CopySourceIfModifiedSince?: Date; /** * Copies the object if its entity tag (ETag) is different than the specified ETag. */ CopySourceIfNoneMatch?: string; /** * Copies the object if it hasn't been modified since the specified time. */ CopySourceIfUnmodifiedSince?: Date; /** * The 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 * <code>x-amz-server-side-encryption-customer-algorithm</code> 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; /** * Specifies the algorithm to use when decrypting the source object (for example, * AES256). */ CopySourceSSECustomerAlgorithm?: string; /** * Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source * object. The encryption key provided in this header must be one that was used when the * source object was created. */ CopySourceSSECustomerKey?: string; /** * Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses * this header for a message integrity check to ensure that the encryption key was transmitted * without error. */ CopySourceSSECustomerKeyMD5?: string; /** * Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. For information about downloading * objects from requester pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requestor Pays Buckets</a> in the Amazon S3 Developer Guide. */ RequestPayer?: RequestPayer | string; /** * The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; /** * The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedSourceBucketOwner?: string; } export namespace UploadPartCopyRequest { export const filterSensitiveLog = (obj: UploadPartCopyRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), ...(obj.CopySourceSSECustomerKey && { CopySourceSSECustomerKey: SENSITIVE_STRING }), }); }