@aws-sdk/client-s3

import type { StreamingBlobTypes } from "@smithy/types"; import type { AnnotationConfigurationState, ChecksumAlgorithm, CompressionType, ExpressionType, FileHeaderInfo, InventoryConfigurationState, JSONType, ObjectCannedACL, ObjectLockLegalHoldStatus, ObjectLockMode, QuoteFields, ReplicationStatus, RequestCharged, RequestPayer, RestoreRequestType, ServerSideEncryption, StorageClass, Tier } from "./enums"; import type { Grant, MetadataTableEncryptionConfiguration, RecordExpiration, Tagging } from "./models_0"; /** * @public */ export interface RenameObjectOutput { } /** * @public */ export interface RenameObjectRequest { /** * The bucket name of the directory bucket containing the object. * You must use virtual-hosted-style requests in the format * <code>Bucket-name.s3express-zone-id.region-code.amazonaws.com</code>. Path-style requests are not * supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must * follow the format <code>bucket-base-name--zone-id--x-s3 </code> (for example, * <code>amzn-s3-demo-bucket--usw2-az1--x-s3</code>). For information about bucket naming restrictions, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the Amazon S3 User Guide. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * Key name of the object to rename. * @public */ Key: string | undefined; /** * Specifies the source for the rename operation. The value must be URL encoded. * @public */ RenameSource: string | undefined; /** * Renames the object only if the ETag (entity tag) value provided during the operation matches the * ETag of the object in S3. The <code>If-Match</code> header field makes the request method conditional on * ETags. If the ETag values do not match, the operation returns a <code>412 Precondition Failed</code> * error. * Expects the ETag value as a string. * @public */ DestinationIfMatch?: string | undefined; /** * Renames the object only if the destination does not already exist in the specified directory * bucket. If the object does exist when you send a request with <code>If-None-Match:*</code>, the S3 API * will return a <code>412 Precondition Failed</code> error, preventing an overwrite. The * <code>If-None-Match</code> header prevents overwrites of existing data by validating that there's not * an object with the same key name already in your directory bucket. * Expects the <code>*</code> character (asterisk). * @public */ DestinationIfNoneMatch?: string | undefined; /** * Renames the object if the destination exists and if it has been modified since the specified * time. * @public */ DestinationIfModifiedSince?: Date | undefined; /** * Renames the object if it hasn't been modified since the specified time. * @public */ DestinationIfUnmodifiedSince?: Date | undefined; /** * Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag. * * @public */ SourceIfMatch?: string | undefined; /** * Renames the object if the source exists and if its entity tag (ETag) is different than the specified * ETag. If an asterisk (<code>*</code>) character is provided, the operation will fail and return a * <code>412 Precondition Failed</code> error. * @public */ SourceIfNoneMatch?: string | undefined; /** * Renames the object if the source exists and if it has been modified since the specified time. * @public */ SourceIfModifiedSince?: Date | undefined; /** * Renames the object if the source exists and hasn't been modified since the specified time. * @public */ SourceIfUnmodifiedSince?: Date | undefined; /** * A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126. * <note> * * <code>RenameObject</code> supports idempotency using a client token. To make an idempotent API request * using <code>RenameObject</code>, specify a client token in the request. You should not reuse the same * client token for other API requests. If you retry a request that completed successfully using the same * client token and the same parameters, the retry succeeds without performing any further actions. If * you retry a successful request using the same client token, but one or more of the parameters are * different, the retry fails and an <code>IdempotentParameterMismatch</code> error is returned. * </note> * @public */ ClientToken?: string | undefined; } /** * @public */ export interface RestoreObjectOutput { /** * If present, indicates that the requester was successfully charged for the request. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the Amazon Simple * Storage Service user guide. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestCharged?: RequestCharged | undefined; /** * Indicates the path in the provided S3 output location where Select results will be restored * to. * @public */ RestoreOutputPath?: string | undefined; } /** * Container for S3 Glacier job parameters. * @public */ export interface GlacierJobParameters { /** * Retrieval tier at which the restore will be processed. * @public */ Tier: Tier | undefined; } /** * Contains the type of server-side encryption used. * @public */ export interface Encryption { /** * The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, * <code>aws:kms</code>). * @public */ EncryptionType: ServerSideEncryption | undefined; /** * If the encryption type is <code>aws:kms</code>, 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 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric keys in KMS</a> in the * Amazon Web Services Key Management Service Developer Guide. * @public */ KMSKeyId?: string | undefined; /** * If the encryption type is <code>aws:kms</code>, this optional value can be used to specify the * encryption context for the restore results. * @public */ KMSContext?: string | undefined; } /** * A metadata key-value pair to store with an object. * @public */ export interface MetadataEntry { /** * Name of the object. * @public */ Name?: string | undefined; /** * Value of the object. * @public */ Value?: string | undefined; } /** * Describes an Amazon S3 location that will receive the results of the restore request. * @public */ export interface S3Location { /** * The name of the bucket where the restore results will be placed. * @public */ BucketName: string | undefined; /** * The prefix that is prepended to the restore results for this request. * @public */ Prefix: string | undefined; /** * Contains the type of server-side encryption used. * @public */ Encryption?: Encryption | undefined; /** * The canned ACL to apply to the restore results. * @public */ CannedACL?: ObjectCannedACL | undefined; /** * A list of grants that control access to the staged results. * @public */ AccessControlList?: Grant[] | undefined; /** * The tag-set that is applied to the restore results. * @public */ Tagging?: Tagging | undefined; /** * A list of metadata to store with the restore results in S3. * @public */ UserMetadata?: MetadataEntry[] | undefined; /** * The class of storage used to store the restore results. * @public */ StorageClass?: StorageClass | undefined; } /** * Describes the location where the restore job's output is stored. * @public */ export interface OutputLocation { /** * Describes an S3 location that will receive the results of the restore request. * @public */ S3?: S3Location | undefined; } /** * Describes how an uncompressed comma-separated values (CSV)-formatted input object is * formatted. * @public */ 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> * @public */ FileHeaderInfo?: FileHeaderInfo | undefined; /** * 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 <code>#</code>. * Default: <code>#</code> * * @public */ Comments?: string | undefined; /** * 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>. * @public */ QuoteEscapeCharacter?: string | undefined; /** * A single character used to separate individual records in the input. Instead of the default value, * you can specify an arbitrary delimiter. * @public */ RecordDelimiter?: string | undefined; /** * A single character used to separate individual fields in a record. You can specify an arbitrary * delimiter. * @public */ FieldDelimiter?: string | undefined; /** * 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> * * @public */ QuoteCharacter?: string | undefined; /** * 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. * @public */ AllowQuotedRecordDelimiter?: boolean | undefined; } /** * Specifies JSON as object's input serialization format. * @public */ export interface JSONInput { /** * The type of JSON. Valid values: Document, Lines. * @public */ Type?: JSONType | undefined; } /** * Container for Parquet. * @public */ export interface ParquetInput { } /** * Describes the serialization format of the object. * @public */ export interface InputSerialization { /** * Describes the serialization of a CSV-encoded object. * @public */ CSV?: CSVInput | undefined; /** * Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE. * @public */ CompressionType?: CompressionType | undefined; /** * Specifies JSON as object's input serialization format. * @public */ JSON?: JSONInput | undefined; /** * Specifies Parquet as object's input serialization format. * @public */ Parquet?: ParquetInput | undefined; } /** * Describes how uncompressed comma-separated values (CSV)-formatted results are formatted. * @public */ 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> * @public */ QuoteFields?: QuoteFields | undefined; /** * The single character used for escaping the quote character inside an already escaped value. * @public */ QuoteEscapeCharacter?: string | undefined; /** * A single character used to separate individual records in the output. Instead of the default value, * you can specify an arbitrary delimiter. * @public */ RecordDelimiter?: string | undefined; /** * The value used to separate individual fields in a record. You can specify an arbitrary * delimiter. * @public */ FieldDelimiter?: string | undefined; /** * 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>. * @public */ QuoteCharacter?: string | undefined; } /** * Specifies JSON as request's output serialization format. * @public */ 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'). * @public */ RecordDelimiter?: string | undefined; } /** * Describes how results of the Select job are serialized. * @public */ export interface OutputSerialization { /** * Describes the serialization of CSV-encoded Select results. * @public */ CSV?: CSVOutput | undefined; /** * Specifies JSON as request's output serialization format. * @public */ JSON?: JSONOutput | undefined; } /** * <important> * Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can * continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a> * * </important> * Describes the parameters for Select job types. * Learn <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">How to * optimize querying your data in Amazon S3</a> using <a href="https://docs.aws.amazon.com/athena/latest/ug/what-is.html">Amazon Athena</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">S3 Object Lambda</a>, or client-side * filtering. * @public */ export interface SelectParameters { /** * Describes the serialization format of the object. * @public */ InputSerialization: InputSerialization | undefined; /** * The type of the provided expression (for example, SQL). * @public */ ExpressionType: ExpressionType | undefined; /** * <important> * Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can * continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a> * * </important> * The expression that is used to query the object. * @public */ Expression: string | undefined; /** * Describes how the results of the Select job are serialized. * @public */ OutputSerialization: OutputSerialization | undefined; } /** * Container for restore job parameters. * @public */ 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. * @public */ Days?: number | undefined; /** * S3 Glacier related parameters pertaining to this job. Do not use with restores that specify * <code>OutputLocation</code>. * @public */ GlacierJobParameters?: GlacierJobParameters | undefined; /** * <important> * Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can * continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a> * * </important> * Type of restore request. * @public */ Type?: RestoreRequestType | undefined; /** * Retrieval tier at which the restore will be processed. * @public */ Tier?: Tier | undefined; /** * The optional description for the job. * @public */ Description?: string | undefined; /** * <important> * Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can * continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a> * * </important> * Describes the parameters for Select job types. * @public */ SelectParameters?: SelectParameters | undefined; /** * Describes the location where the restore job's output is stored. * @public */ OutputLocation?: OutputLocation | undefined; } /** * @public */ export interface RestoreObjectRequest { /** * The bucket name containing the object to restore. * * Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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. * * S3 on Outposts - When you use this action with 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 you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is 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 * @public */ Bucket: string | undefined; /** * Object key for which the action was initiated. * @public */ Key: string | undefined; /** * VersionId used to reference a specific version of the object. * @public */ VersionId?: string | undefined; /** * Container for restore job parameters. * @public */ RestoreRequest?: RestoreRequest | undefined; /** * Confirms that the requester knows that they will be charged for the request. Bucket owners need not * specify this parameter in their requests. If either the source or destination S3 bucket has Requester * Pays enabled, the requester will pay for the corresponding charges. 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. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestPayer?: RequestPayer | undefined; /** * Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> * parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * * @public */ export interface 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>. * @public */ export interface EndEvent { } /** * This data type contains information about progress of an operation. * @public */ export interface Progress { /** * The current number of object bytes scanned. * @public */ BytesScanned?: number | undefined; /** * The current number of uncompressed object bytes processed. * @public */ BytesProcessed?: number | undefined; /** * The current number of bytes of records payload data returned. * @public */ BytesReturned?: number | undefined; } /** * This data type contains information about the progress event of an operation. * @public */ export interface ProgressEvent { /** * The Progress event details. * @public */ Details?: Progress | undefined; } /** * The container for the records event. * @public */ export interface RecordsEvent { /** * The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record * will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might * split the same record across multiple record frames instead of aggregating the results in memory. Some * S3 clients (for example, the SDK for Java) handle this behavior by creating a * <code>ByteStream</code> out of the response by default. Other clients might not handle this behavior * by default. In those cases, you must aggregate the results on the client side and parse the * response. * @public */ Payload?: Uint8Array | undefined; } /** * Container for the stats details. * @public */ export interface Stats { /** * The total number of object bytes scanned. * @public */ BytesScanned?: number | undefined; /** * The total number of uncompressed object bytes processed. * @public */ BytesProcessed?: number | undefined; /** * The total number of bytes of records payload data returned. * @public */ BytesReturned?: number | undefined; } /** * Container for the Stats Event. * @public */ export interface StatsEvent { /** * The Stats event details. * @public */ Details?: Stats | undefined; } /** * The container for selecting objects from a content event stream. * @public */ export type SelectObjectContentEventStream = SelectObjectContentEventStream.ContMember | SelectObjectContentEventStream.EndMember | SelectObjectContentEventStream.ProgressMember | SelectObjectContentEventStream.RecordsMember | SelectObjectContentEventStream.StatsMember | SelectObjectContentEventStream.$UnknownMember; /** * @public */ export declare namespace SelectObjectContentEventStream { /** * The Records Event. * @public */ interface RecordsMember { Records: RecordsEvent; Stats?: never; Progress?: never; Cont?: never; End?: never; $unknown?: never; } /** * The Stats Event. * @public */ interface StatsMember { Records?: never; Stats: StatsEvent; Progress?: never; Cont?: never; End?: never; $unknown?: never; } /** * The Progress Event. * @public */ interface ProgressMember { Records?: never; Stats?: never; Progress: ProgressEvent; Cont?: never; End?: never; $unknown?: never; } /** * The Continuation Event. * @public */ interface ContMember { Records?: never; Stats?: never; Progress?: never; Cont: ContinuationEvent; End?: never; $unknown?: never; } /** * The End Event. * @public */ interface EndMember { Records?: never; Stats?: never; Progress?: never; Cont?: never; End: EndEvent; $unknown?: never; } /** * @public */ interface $UnknownMember { Records?: never; Stats?: never; Progress?: never; Cont?: never; End?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ 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; } } /** * @public */ export interface SelectObjectContentOutput { /** * The array of results. * @public */ Payload?: AsyncIterable<SelectObjectContentEventStream> | undefined; } /** * Container for specifying if periodic <code>QueryProgress</code> messages should be sent. * @public */ export interface RequestProgress { /** * Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default * value: FALSE. * @public */ Enabled?: boolean | 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. * @public */ 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. * @public */ Start?: number | undefined; /** * 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. * @public */ End?: number | undefined; } /** * <note> * Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 * Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a> * * </note> * 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>. * @public */ 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 * @public */ Bucket: string | undefined; /** * The object key. * @public */ 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. * @public */ SSECustomerAlgorithm?: string | undefined; /** * 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. * @public */ SSECustomerKey?: string | undefined; /** * 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. * @public */ SSECustomerKeyMD5?: string | undefined; /** * The expression that is used to query the object. * @public */ Expression: string | undefined; /** * The type of the provided expression (for example, SQL). * @public */ ExpressionType: ExpressionType | undefined; /** * Specifies if periodic request progress information should be enabled. * @public */ RequestProgress?: RequestProgress | undefined; /** * Describes the format of the data in the object that is being queried. * @public */ InputSerialization: InputSerialization | undefined; /** * Describes the format of the data that you want Amazon S3 to return in response. * @public */ 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> * @public */ ScanRange?: ScanRange | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * Specifies updates to apply to the annotation table configuration. Used as the request body for * <code>UpdateBucketMetadataAnnotationTableConfiguration</code>. * @public */ export interface AnnotationTableConfigurationUpdates { /** * The new configuration state to apply. * @public */ ConfigurationState: AnnotationConfigurationState | undefined; /** * * The encryption settings for an S3 Metadata journal table or inventory table configuration. * * @public */ EncryptionConfiguration?: MetadataTableEncryptionConfiguration | undefined; /** * The new IAM role ARN to apply. * @public */ Role?: string | undefined; } /** * @public */ export interface UpdateBucketMetadataAnnotationTableConfigurationRequest { /** * The name of the bucket whose annotation table configuration to update. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * Base64-encoded MD5 digest of the message body. * @public */ ContentMD5?: string | undefined; /** * Checksum algorithm for the request payload. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * The annotation table configuration updates to apply. * @public */ AnnotationTableConfiguration: AnnotationTableConfigurationUpdates | undefined; /** * The account ID of the expected bucket owner. * @public */ ExpectedBucketOwner?: string | undefined; } /** * * The specified updates to the S3 Metadata inventory table configuration. * * @public */ export interface InventoryTableConfigurationUpdates { /** * * The configuration state of the inventory table, indicating whether the inventory table is enabled * or disabled. * * @public */ ConfigurationState: InventoryConfigurationState | undefined; /** * * The encryption configuration for the inventory table. * * @public */ EncryptionConfiguration?: MetadataTableEncryptionConfiguration | undefined; } /** * @public */ export interface UpdateBucketMetadataInventoryTableConfigurationRequest { /** * * The general purpose bucket that corresponds to the metadata configuration that you want to * enable or disable an inventory table for. * * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * * The <code>Content-MD5</code> header for the inventory table configuration. * * @public */ ContentMD5?: string | undefined; /** * * The checksum algorithm to use with your inventory table configuration. * * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * * The contents of your inventory table configuration. * * @public */ InventoryTableConfiguration: InventoryTableConfigurationUpdates | undefined; /** * * The expected owner of the general purpose bucket that corresponds to the metadata table * configuration that you want to enable or disable an inventory table for. * * @public */ ExpectedBucketOwner?: string | undefined; } /** * * The specified updates to the S3 Metadata journal table configuration. * * @public */ export interface JournalTableConfigurationUpdates { /** * * The journal table record expiration settings for the journal table. * * @public */ RecordExpiration: RecordExpiration | undefined; } /** * @public */ export interface UpdateBucketMetadataJournalTableConfigurationRequest { /** * * The general purpose bucket that corresponds to the metadata configuration that you want to * enable or disable journal table record expiration for. * * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * * The <code>Content-MD5</code> header for the journal table configuration. * * @public */ ContentMD5?: string | undefined; /** * * The checksum algorithm to use with your journal table configuration. * * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * * The contents of your journal table configuration. * * @public */ JournalTableConfiguration: JournalTableConfigurationUpdates | undefined; /** * * The expected owner of the general purpose bucket that corresponds to the metadata table * configuration that you want to enable or disable journal table record expiration for. * * @public */ ExpectedBucketOwner?: string | undefined; } /** * * If <code>SSEKMS</code> is specified for <code>ObjectEncryption</code>, this data type specifies * the Amazon Web Services KMS key Amazon Resource Name (ARN) to use and whether to use an S3 Bucket Key for * server-side encryption using Key Management Service (KMS) keys (SSE-KMS). * * @public */ export interface SSEKMSEncryption { /** * * Specifies the Amazon Web Services KMS key Amazon Resource Name (ARN) to use for the updated server-side encryption * type. Required if <code>ObjectEncryption</code> specifies <code>SSEKMS</code>. * * <note> * You must specify the full Amazon Web Services KMS key ARN. The KMS key ID and KMS key alias aren't * supported. * </note> * Pattern: (<code>arn:aws[-a-z0-9]*:kms:[-a-z0-9]*:[0-9]\{12\}:key/.+</code>) * @public */ KMSKeyArn: string | undefined; /** * * Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption * using Key Management Service (KMS) keys (SSE-KMS). If this value isn't specified, it defaults to <code>false</code>. * Setting this value to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with * SSE-KMS. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html"> * Using Amazon S3 Bucket Keys</a> in the Amazon S3 User Guide. * * Valid Values: <code>true</code> | <code>false</code> * * @public */ BucketKeyEnabled?: boolean | undefined; } /** * * The updated server-side encryption type for this object. The <code>UpdateObjectEncryption</code> * operation supports the SSE-S3 and SSE-KMS encryption types. * * Valid Values: <code>SSES3</code> | <code>SSEKMS</code> * * @public */ export type ObjectEncryption = ObjectEncryption.SSEKMSMember | ObjectEncryption.$UnknownMember; /** * @public */ export declare namespace ObjectEncryption { /** * * Specifies to update the object encryption type to server-side encryption with Key Management Service (KMS) keys * (SSE-KMS). * * @public */ interface SSEKMSMember { SSEKMS: SSEKMSEncryption; $unknown?: never; } /** * @public */ interface $UnknownMember { SSEKMS?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface Visitor<T> { SSEKMS: (value: SSEKMSEncryption) => T; _: (name: string, value: any) => T; } } /** * @public */ export interface UpdateObjectEncryptionRequest { /** * * The name of the general purpose bucket that contains the specified object key name. * * When you use this operation with an access point attached to a general purpose bucket, you * must either provide the alias of the access point in place of the bucket name or you must specify * the access point Amazon Resource Name (ARN). When using the access point ARN, you must direct * requests to the access point hostname. The access point hostname takes the form * <code> * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com</code>. * When using this operation 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/access-points-naming.html"> * Referencing 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 * @public */ Bucket: string | undefined; /** * * The key name of the object that you want to update the server-side encryption type for. * * @public */ Key: string | undefined; /** * * The version ID of the object that you want to update the server-side encryption type for. * * @public */ VersionId?: string | undefined; /** * * The updated server-side encryption type for this object. The <code>UpdateObjectEncryption</code> * operation supports the SSE-S3 and SSE-KMS encryption types. * * Valid Values: <code>SSES3</code> | <code>SSEKMS</code> * * @public */ ObjectEncryption: ObjectEncryption | undefined; /** * Confirms that the requester knows that they will be charged for the request. Bucket owners need not * specify this parameter in their requests. If either the source or destination S3 bucket has Requester * Pays enabled, the requester will pay for the corresponding charges. 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. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestPayer?: RequestPayer | undefined; /** * * The account ID of the expected bucket owner. If the account ID that you provide doesn't match the * actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> * (access denied). * * @public */ ExpectedBucketOwner?: string | undefined; /** * * The 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. * * @public */ ContentMD5?: string | undefined; /** * * Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK. This header * doesn't provide any additional functionality if you don't use the SDK. When you send this header, * there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html"> * Checking object integrity </a> in the Amazon S3 User Guide. * * If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> * parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; } /** * @public */ export interface UpdateObjectEncryptionResponse { /** * If