UNPKG

510 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {S3Customizations} from '../lib/services/s3';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8import {UseDualstackConfigOptions} from '../lib/config_use_dualstack';
9import {EventStream} from '../lib/event-stream/event-stream';
10import {ManagedUpload as managed_upload} from '../lib/s3/managed_upload';
11import {PresignedPost as presigned_post} from '../lib/s3/presigned_post';
12import {Readable} from 'stream';
13interface Blob {}
14declare class S3 extends S3Customizations {
15 /**
16 * Constructs a service object. This object has one method for each API operation.
17 */
18 constructor(options?: S3.Types.ClientConfiguration)
19 config: Config & S3.Types.ClientConfiguration;
20 /**
21 * This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty. For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions. The following operations are related to AbortMultipartUpload: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts ListMultipartUploads
22 */
23 abortMultipartUpload(params: S3.Types.AbortMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.AbortMultipartUploadOutput) => void): Request<S3.Types.AbortMultipartUploadOutput, AWSError>;
24 /**
25 * This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty. For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions. The following operations are related to AbortMultipartUpload: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts ListMultipartUploads
26 */
27 abortMultipartUpload(callback?: (err: AWSError, data: S3.Types.AbortMultipartUploadOutput) => void): Request<S3.Types.AbortMultipartUploadOutput, AWSError>;
28 /**
29 * Completes a multipart upload by assembling previously uploaded parts. You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded. Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded. Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices. For more information about multipart uploads, see Uploading Objects Using Multipart Upload. For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions. GetBucketLifecycle has the following special errors: Error code: EntityTooSmall Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part. 400 Bad Request Error code: InvalidPart Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag. 400 Bad Request Error code: InvalidPartOrder Description: The list of parts was not in ascending order. The parts list must be specified in order by part number. 400 Bad Request Error code: NoSuchUpload Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. 404 Not Found The following operations are related to DeleteBucketMetricsConfiguration: CreateMultipartUpload UploadPart AbortMultipartUpload ListParts ListMultipartUploads
30 */
31 completeMultipartUpload(params: S3.Types.CompleteMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.CompleteMultipartUploadOutput) => void): Request<S3.Types.CompleteMultipartUploadOutput, AWSError>;
32 /**
33 * Completes a multipart upload by assembling previously uploaded parts. You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded. Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded. Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices. For more information about multipart uploads, see Uploading Objects Using Multipart Upload. For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions. GetBucketLifecycle has the following special errors: Error code: EntityTooSmall Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part. 400 Bad Request Error code: InvalidPart Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag. 400 Bad Request Error code: InvalidPartOrder Description: The list of parts was not in ascending order. The parts list must be specified in order by part number. 400 Bad Request Error code: NoSuchUpload Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. 404 Not Found The following operations are related to DeleteBucketMetricsConfiguration: CreateMultipartUpload UploadPart AbortMultipartUpload ListParts ListMultipartUploads
34 */
35 completeMultipartUpload(callback?: (err: AWSError, data: S3.Types.CompleteMultipartUploadOutput) => void): Request<S3.Types.CompleteMultipartUploadOutput, AWSError>;
36 /**
37 * Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, for copying an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API. When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs. Amazon S3 transfer acceleration does not support cross-region copies. If you request a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information about transfer acceleration, see Transfer Acceleration. All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. You can use this operation to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes. The source object that you are copying can be encrypted or unencrypted. If the source object is encrypted, it can be encrypted by server-side encryption using AWS managed encryption keys or by using a customer-provided encryption key. When copying an object, you can request that Amazon S3 encrypt the target object by using either the AWS managed encryption keys or by using your own encryption key. You can do this regardless of the form of server-side encryption that was used to encrypt the source, or even if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. Consider the following when using request headers: Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data: x-amz-copy-source-if-match condition evaluates to true x-amz-copy-source-if-unmodified-since condition evaluates to false Consideration 2 – If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code: x-amz-copy-source-if-none-match condition evaluates to false x-amz-copy-source-if-modified-since condition evaluates to true The copy request charge is based on the storage class and Region you specify for the destination object. For pricing information, see Amazon S3 Pricing. Following are other considerations when using CopyObject: Versioning By default, x-amz-copy-source identifies the current version of an object to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object was deleted.) To copy a different version, use the versionId subresource. If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response. If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null. If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see . Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers To encrypt the target object, you must provide the appropriate encryption-related request headers. The one you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. To encrypt the target object using server-side encryption with an AWS managed encryption key, provide the following request headers, as appropriate. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in KMS. To encrypt the target object using server-side encryption with an encryption key that you provide, use the following headers. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 If the source object is encrypted using server-side encryption with customer-provided encryption keys, you must use the following headers. x-amz-copy-source​-server-side​-encryption​-customer-algorithm x-amz-copy-source​-server-side​-encryption​-customer-key x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon KMS. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" The following operations are related to CopyObject: PutObject GetObject For more information, see Copying Objects.
38 */
39 copyObject(params: S3.Types.CopyObjectRequest, callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request<S3.Types.CopyObjectOutput, AWSError>;
40 /**
41 * Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, for copying an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API. When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs. Amazon S3 transfer acceleration does not support cross-region copies. If you request a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information about transfer acceleration, see Transfer Acceleration. All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the request parameters x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, or x-amz-copy-source-if-modified-since. All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. You can use this operation to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes. The source object that you are copying can be encrypted or unencrypted. If the source object is encrypted, it can be encrypted by server-side encryption using AWS managed encryption keys or by using a customer-provided encryption key. When copying an object, you can request that Amazon S3 encrypt the target object by using either the AWS managed encryption keys or by using your own encryption key. You can do this regardless of the form of server-side encryption that was used to encrypt the source, or even if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. Consider the following when using request headers: Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data: x-amz-copy-source-if-match condition evaluates to true x-amz-copy-source-if-unmodified-since condition evaluates to false Consideration 2 – If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code: x-amz-copy-source-if-none-match condition evaluates to false x-amz-copy-source-if-modified-since condition evaluates to true The copy request charge is based on the storage class and Region you specify for the destination object. For pricing information, see Amazon S3 Pricing. Following are other considerations when using CopyObject: Versioning By default, x-amz-copy-source identifies the current version of an object to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object was deleted.) To copy a different version, use the versionId subresource. If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response. If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null. If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see . Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers To encrypt the target object, you must provide the appropriate encryption-related request headers. The one you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. To encrypt the target object using server-side encryption with an AWS managed encryption key, provide the following request headers, as appropriate. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in KMS. To encrypt the target object using server-side encryption with an encryption key that you provide, use the following headers. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 If the source object is encrypted using server-side encryption with customer-provided encryption keys, you must use the following headers. x-amz-copy-source​-server-side​-encryption​-customer-algorithm x-amz-copy-source​-server-side​-encryption​-customer-key x-amz-copy-source-​server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon KMS. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" The following operations are related to CopyObject: PutObject GetObject For more information, see Copying Objects.
42 */
43 copyObject(callback?: (err: AWSError, data: S3.Types.CopyObjectOutput) => void): Request<S3.Types.CopyObjectOutput, AWSError>;
44 /**
45 * Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner. Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets. By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the EU (Ireland) Region. For more information, see How to Select a Region for Your Buckets. If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual Hosting of Buckets. When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers. Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. The following operations are related to CreateBucket: PutObject DeleteBucket
46 */
47 createBucket(params: S3.Types.CreateBucketRequest, callback?: (err: AWSError, data: S3.Types.CreateBucketOutput) => void): Request<S3.Types.CreateBucketOutput, AWSError>;
48 /**
49 * Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner. Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets. By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the EU (Ireland) Region. For more information, see How to Select a Region for Your Buckets. If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual Hosting of Buckets. When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers. Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. The following operations are related to CreateBucket: PutObject DeleteBucket
50 */
51 createBucket(callback?: (err: AWSError, data: S3.Types.CreateBucketOutput) => void): Request<S3.Types.CreateBucketOutput, AWSError>;
52 /**
53 * This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview. If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions. For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart) and UploadPartCopy) requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, and kms:DescribeKey actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption. Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" The following operations are related to CreateMultipartUpload: UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
54 */
55 createMultipartUpload(params: S3.Types.CreateMultipartUploadRequest, callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request<S3.Types.CreateMultipartUploadOutput, AWSError>;
56 /**
57 * This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview. If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions. For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart) and UploadPartCopy) requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, and kms:DescribeKey actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption. Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" The following operations are related to CreateMultipartUpload: UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
58 */
59 createMultipartUpload(callback?: (err: AWSError, data: S3.Types.CreateMultipartUploadOutput) => void): Request<S3.Types.CreateMultipartUploadOutput, AWSError>;
60 /**
61 * Deletes the bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. Related Resources
62 */
63 deleteBucket(params: S3.Types.DeleteBucketRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
64 /**
65 * Deletes the bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. Related Resources
66 */
67 deleteBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
68 /**
69 * Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis. The following operations are related to DeleteBucketAnalyticsConfiguration:
70 */
71 deleteBucketAnalyticsConfiguration(params: S3.Types.DeleteBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
72 /**
73 * Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis. The following operations are related to DeleteBucketAnalyticsConfiguration:
74 */
75 deleteBucketAnalyticsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
76 /**
77 * Deletes the cors configuration information set for the bucket. To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others. For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide. Related Resources: RESTOPTIONSobject
78 */
79 deleteBucketCors(params: S3.Types.DeleteBucketCorsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
80 /**
81 * Deletes the cors configuration information set for the bucket. To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others. For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide. Related Resources: RESTOPTIONSobject
82 */
83 deleteBucketCors(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
84 /**
85 * This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide. To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Related Resources PutBucketEncryption GetBucketEncryption
86 */
87 deleteBucketEncryption(params: S3.Types.DeleteBucketEncryptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
88 /**
89 * This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide. To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Related Resources PutBucketEncryption GetBucketEncryption
90 */
91 deleteBucketEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
92 /**
93 * Deletes an inventory configuration (identified by the inventory ID) from the bucket. To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory. Operations related to DeleteBucketInventoryConfiguration include: GetBucketInventoryConfiguration PutBucketInventoryConfiguration ListBucketInventoryConfigurations
94 */
95 deleteBucketInventoryConfiguration(params: S3.Types.DeleteBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
96 /**
97 * Deletes an inventory configuration (identified by the inventory ID) from the bucket. To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory. Operations related to DeleteBucketInventoryConfiguration include: GetBucketInventoryConfiguration PutBucketInventoryConfiguration ListBucketInventoryConfigurations
98 */
99 deleteBucketInventoryConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
100 /**
101 * Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others. There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. For more information about the object expiration, see Elements to Describe Lifecycle Actions. Related actions include: PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
102 */
103 deleteBucketLifecycle(params: S3.Types.DeleteBucketLifecycleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
104 /**
105 * Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others. There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. For more information about the object expiration, see Elements to Describe Lifecycle Actions. Related actions include: PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
106 */
107 deleteBucketLifecycle(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
108 /**
109 * Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to DeleteBucketMetricsConfiguration: GetBucketMetricsConfiguration PutBucketMetricsConfiguration ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch
110 */
111 deleteBucketMetricsConfiguration(params: S3.Types.DeleteBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
112 /**
113 * Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to DeleteBucketMetricsConfiguration: GetBucketMetricsConfiguration PutBucketMetricsConfiguration ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch
114 */
115 deleteBucketMetricsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
116 /**
117 * This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation. If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and UserPolicies. The following operations are related to DeleteBucketPolicy CreateBucket DeleteObject
118 */
119 deleteBucketPolicy(params: S3.Types.DeleteBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
120 /**
121 * This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation. If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and UserPolicies. The following operations are related to DeleteBucketPolicy CreateBucket DeleteObject
122 */
123 deleteBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
124 /**
125 * Deletes the replication configuration from the bucket. To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. It can take a while for the deletion of a replication configuration to fully propagate. For information about replication configuration, see Replication in the Amazon S3 Developer Guide. The following operations are related to DeleteBucketReplication: PutBucketReplication GetBucketReplication
126 */
127 deleteBucketReplication(params: S3.Types.DeleteBucketReplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
128 /**
129 * Deletes the replication configuration from the bucket. To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. It can take a while for the deletion of a replication configuration to fully propagate. For information about replication configuration, see Replication in the Amazon S3 Developer Guide. The following operations are related to DeleteBucketReplication: PutBucketReplication GetBucketReplication
130 */
131 deleteBucketReplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
132 /**
133 * Deletes the tags from the bucket. To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. The following operations are related to DeleteBucketTagging: GetBucketTagging PutBucketTagging
134 */
135 deleteBucketTagging(params: S3.Types.DeleteBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
136 /**
137 * Deletes the tags from the bucket. To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. The following operations are related to DeleteBucketTagging: GetBucketTagging PutBucketTagging
138 */
139 deleteBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
140 /**
141 * This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist. This DELETE operation requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission. For more information about hosting websites, see Hosting Websites on Amazon S3. The following operations are related to DeleteBucketWebsite: GetBucketWebsite PutBucketWebsite
142 */
143 deleteBucketWebsite(params: S3.Types.DeleteBucketWebsiteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
144 /**
145 * This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist. This DELETE operation requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission. For more information about hosting websites, see Hosting Websites on Amazon S3. The following operations are related to DeleteBucketWebsite: GetBucketWebsite PutBucketWebsite
146 */
147 deleteBucketWebsite(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
148 /**
149 * Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true. If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS. For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request. You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions. The following operation is related to DeleteObject: PutObject
150 */
151 deleteObject(params: S3.Types.DeleteObjectRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectOutput) => void): Request<S3.Types.DeleteObjectOutput, AWSError>;
152 /**
153 * Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true. If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS. For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request. You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions. The following operation is related to DeleteObject: PutObject
154 */
155 deleteObject(callback?: (err: AWSError, data: S3.Types.DeleteObjectOutput) => void): Request<S3.Types.DeleteObjectOutput, AWSError>;
156 /**
157 * Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging. To use this operation, you must have permission to perform the s3:DeleteObjectTagging action. To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action. The following operations are related to DeleteBucketMetricsConfiguration: PutObjectTagging GetObjectTagging
158 */
159 deleteObjectTagging(params: S3.Types.DeleteObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectTaggingOutput) => void): Request<S3.Types.DeleteObjectTaggingOutput, AWSError>;
160 /**
161 * Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging. To use this operation, you must have permission to perform the s3:DeleteObjectTagging action. To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action. The following operations are related to DeleteBucketMetricsConfiguration: PutObjectTagging GetObjectTagging
162 */
163 deleteObjectTagging(callback?: (err: AWSError, data: S3.Types.DeleteObjectTaggingOutput) => void): Request<S3.Types.DeleteObjectTaggingOutput, AWSError>;
164 /**
165 * This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead. The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted. The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body. When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete. Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit. The following operations are related to DeleteObjects: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts AbortMultipartUpload
166 */
167 deleteObjects(params: S3.Types.DeleteObjectsRequest, callback?: (err: AWSError, data: S3.Types.DeleteObjectsOutput) => void): Request<S3.Types.DeleteObjectsOutput, AWSError>;
168 /**
169 * This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead. The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted. The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body. When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete. Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit. The following operations are related to DeleteObjects: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts AbortMultipartUpload
170 */
171 deleteObjects(callback?: (err: AWSError, data: S3.Types.DeleteObjectsOutput) => void): Request<S3.Types.DeleteObjectsOutput, AWSError>;
172 /**
173 * Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The following operations are related to DeleteBucketMetricsConfiguration: Using Amazon S3 Block Public Access GetPublicAccessBlock PutPublicAccessBlock GetBucketPolicyStatus
174 */
175 deletePublicAccessBlock(params: S3.Types.DeletePublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
176 /**
177 * Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The following operations are related to DeleteBucketMetricsConfiguration: Using Amazon S3 Block Public Access GetPublicAccessBlock PutPublicAccessBlock GetBucketPolicyStatus
178 */
179 deletePublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
180 /**
181 * This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3. To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation. A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. For more information about transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide. Related Resources PutBucketAccelerateConfiguration
182 */
183 getBucketAccelerateConfiguration(params: S3.Types.GetBucketAccelerateConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAccelerateConfigurationOutput) => void): Request<S3.Types.GetBucketAccelerateConfigurationOutput, AWSError>;
184 /**
185 * This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3. To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation. A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. For more information about transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide. Related Resources PutBucketAccelerateConfiguration
186 */
187 getBucketAccelerateConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketAccelerateConfigurationOutput) => void): Request<S3.Types.GetBucketAccelerateConfigurationOutput, AWSError>;
188 /**
189 * This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header. Related Resources
190 */
191 getBucketAcl(params: S3.Types.GetBucketAclRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAclOutput) => void): Request<S3.Types.GetBucketAclOutput, AWSError>;
192 /**
193 * This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header. Related Resources
194 */
195 getBucketAcl(callback?: (err: AWSError, data: S3.Types.GetBucketAclOutput) => void): Request<S3.Types.GetBucketAclOutput, AWSError>;
196 /**
197 * This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket. To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide. Related Resources
198 */
199 getBucketAnalyticsConfiguration(params: S3.Types.GetBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketAnalyticsConfigurationOutput) => void): Request<S3.Types.GetBucketAnalyticsConfigurationOutput, AWSError>;
200 /**
201 * This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket. To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide. Related Resources
202 */
203 getBucketAnalyticsConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketAnalyticsConfigurationOutput) => void): Request<S3.Types.GetBucketAnalyticsConfigurationOutput, AWSError>;
204 /**
205 * Returns the cors configuration information set for the bucket. To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others. For more information about cors, see Enabling Cross-Origin Resource Sharing. The following operations are related to GetBucketCors: PutBucketCors DeleteBucketCors
206 */
207 getBucketCors(params: S3.Types.GetBucketCorsRequest, callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request<S3.Types.GetBucketCorsOutput, AWSError>;
208 /**
209 * Returns the cors configuration information set for the bucket. To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others. For more information about cors, see Enabling Cross-Origin Resource Sharing. The following operations are related to GetBucketCors: PutBucketCors DeleteBucketCors
210 */
211 getBucketCors(callback?: (err: AWSError, data: S3.Types.GetBucketCorsOutput) => void): Request<S3.Types.GetBucketCorsOutput, AWSError>;
212 /**
213 * Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption. To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The following operations are related to GetBucketEncryption: PutBucketEncryption DeleteBucketEncryption
214 */
215 getBucketEncryption(params: S3.Types.GetBucketEncryptionRequest, callback?: (err: AWSError, data: S3.Types.GetBucketEncryptionOutput) => void): Request<S3.Types.GetBucketEncryptionOutput, AWSError>;
216 /**
217 * Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption. To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The following operations are related to GetBucketEncryption: PutBucketEncryption DeleteBucketEncryption
218 */
219 getBucketEncryption(callback?: (err: AWSError, data: S3.Types.GetBucketEncryptionOutput) => void): Request<S3.Types.GetBucketEncryptionOutput, AWSError>;
220 /**
221 * Returns an inventory configuration (identified by the inventory configuration ID) from the bucket. To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory. The following operations are related to GetBucketInventoryConfiguration: DeleteBucketInventoryConfiguration ListBucketInventoryConfigurations PutBucketInventoryConfiguration
222 */
223 getBucketInventoryConfiguration(params: S3.Types.GetBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketInventoryConfigurationOutput) => void): Request<S3.Types.GetBucketInventoryConfigurationOutput, AWSError>;
224 /**
225 * Returns an inventory configuration (identified by the inventory configuration ID) from the bucket. To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory. The following operations are related to GetBucketInventoryConfiguration: DeleteBucketInventoryConfiguration ListBucketInventoryConfigurations PutBucketInventoryConfiguration
226 */
227 getBucketInventoryConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketInventoryConfigurationOutput) => void): Request<S3.Types.GetBucketInventoryConfigurationOutput, AWSError>;
228 /**
229 * For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management. To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. GetBucketLifecycle has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following operations are related to GetBucketLifecycle: GetBucketLifecycleConfiguration PutBucketLifecycle DeleteBucketLifecycle
230 */
231 getBucketLifecycle(params: S3.Types.GetBucketLifecycleRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleOutput) => void): Request<S3.Types.GetBucketLifecycleOutput, AWSError>;
232 /**
233 * For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management. To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. GetBucketLifecycle has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following operations are related to GetBucketLifecycle: GetBucketLifecycleConfiguration PutBucketLifecycle DeleteBucketLifecycle
234 */
235 getBucketLifecycle(callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleOutput) => void): Request<S3.Types.GetBucketLifecycleOutput, AWSError>;
236 /**
237 * Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are still using previous version of the lifecycle configuration, it works. For the earlier API description, see GetBucketLifecycle. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management. To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. GetBucketLifecycleConfiguration has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following operations are related to DeleteBucketMetricsConfiguration: GetBucketLifecycle PutBucketLifecycle DeleteBucketLifecycle
238 */
239 getBucketLifecycleConfiguration(params: S3.Types.GetBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleConfigurationOutput) => void): Request<S3.Types.GetBucketLifecycleConfigurationOutput, AWSError>;
240 /**
241 * Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are still using previous version of the lifecycle configuration, it works. For the earlier API description, see GetBucketLifecycle. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management. To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. GetBucketLifecycleConfiguration has the following special error: Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following operations are related to DeleteBucketMetricsConfiguration: GetBucketLifecycle PutBucketLifecycle DeleteBucketLifecycle
242 */
243 getBucketLifecycleConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketLifecycleConfigurationOutput) => void): Request<S3.Types.GetBucketLifecycleConfigurationOutput, AWSError>;
244 /**
245 * Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket. To use this implementation of the operation, you must be the bucket owner. The following operations are related to GetBucketLocation: GetObject CreateBucket
246 */
247 getBucketLocation(params: S3.Types.GetBucketLocationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLocationOutput) => void): Request<S3.Types.GetBucketLocationOutput, AWSError>;
248 /**
249 * Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket. To use this implementation of the operation, you must be the bucket owner. The following operations are related to GetBucketLocation: GetObject CreateBucket
250 */
251 getBucketLocation(callback?: (err: AWSError, data: S3.Types.GetBucketLocationOutput) => void): Request<S3.Types.GetBucketLocationOutput, AWSError>;
252 /**
253 * Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. The following operations are related to GetBucketLogging: CreateBucket PutBucketLogging
254 */
255 getBucketLogging(params: S3.Types.GetBucketLoggingRequest, callback?: (err: AWSError, data: S3.Types.GetBucketLoggingOutput) => void): Request<S3.Types.GetBucketLoggingOutput, AWSError>;
256 /**
257 * Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. The following operations are related to GetBucketLogging: CreateBucket PutBucketLogging
258 */
259 getBucketLogging(callback?: (err: AWSError, data: S3.Types.GetBucketLoggingOutput) => void): Request<S3.Types.GetBucketLoggingOutput, AWSError>;
260 /**
261 * Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to GetBucketMetricsConfiguration: PutBucketMetricsConfiguration DeleteBucketMetricsConfiguration ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch
262 */
263 getBucketMetricsConfiguration(params: S3.Types.GetBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketMetricsConfigurationOutput) => void): Request<S3.Types.GetBucketMetricsConfigurationOutput, AWSError>;
264 /**
265 * Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to GetBucketMetricsConfiguration: PutBucketMetricsConfiguration DeleteBucketMetricsConfiguration ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch
266 */
267 getBucketMetricsConfiguration(callback?: (err: AWSError, data: S3.Types.GetBucketMetricsConfigurationOutput) => void): Request<S3.Types.GetBucketMetricsConfigurationOutput, AWSError>;
268 /**
269 * No longer used, see GetBucketNotificationConfiguration.
270 */
271 getBucketNotification(params: S3.Types.GetBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: S3.Types.NotificationConfigurationDeprecated) => void): Request<S3.Types.NotificationConfigurationDeprecated, AWSError>;
272 /**
273 * No longer used, see GetBucketNotificationConfiguration.
274 */
275 getBucketNotification(callback?: (err: AWSError, data: S3.Types.NotificationConfigurationDeprecated) => void): Request<S3.Types.NotificationConfigurationDeprecated, AWSError>;
276 /**
277 * Returns the notification configuration of a bucket. If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration element. By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission. For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies. The following operation is related to GetBucketNotification: PutBucketNotification
278 */
279 getBucketNotificationConfiguration(params: S3.Types.GetBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: S3.Types.NotificationConfiguration) => void): Request<S3.Types.NotificationConfiguration, AWSError>;
280 /**
281 * Returns the notification configuration of a bucket. If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration element. By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission. For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies. The following operation is related to GetBucketNotification: PutBucketNotification
282 */
283 getBucketNotificationConfiguration(callback?: (err: AWSError, data: S3.Types.NotificationConfiguration) => void): Request<S3.Types.NotificationConfiguration, AWSError>;
284 /**
285 * Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. The following operation is related to GetBucketPolicy: GetObject
286 */
287 getBucketPolicy(params: S3.Types.GetBucketPolicyRequest, callback?: (err: AWSError, data: S3.Types.GetBucketPolicyOutput) => void): Request<S3.Types.GetBucketPolicyOutput, AWSError>;
288 /**
289 * Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. The following operation is related to GetBucketPolicy: GetObject
290 */
291 getBucketPolicy(callback?: (err: AWSError, data: S3.Types.GetBucketPolicyOutput) => void): Request<S3.Types.GetBucketPolicyOutput, AWSError>;
292 /**
293 * Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public". The following operations are related to GetBucketPolicyStatus: Using Amazon S3 Block Public Access GetPublicAccessBlock PutPublicAccessBlock DeletePublicAccessBlock
294 */
295 getBucketPolicyStatus(params: S3.Types.GetBucketPolicyStatusRequest, callback?: (err: AWSError, data: S3.Types.GetBucketPolicyStatusOutput) => void): Request<S3.Types.GetBucketPolicyStatusOutput, AWSError>;
296 /**
297 * Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public". The following operations are related to GetBucketPolicyStatus: Using Amazon S3 Block Public Access GetPublicAccessBlock PutPublicAccessBlock DeletePublicAccessBlock
298 */
299 getBucketPolicyStatus(callback?: (err: AWSError, data: S3.Types.GetBucketPolicyStatusOutput) => void): Request<S3.Types.GetBucketPolicyStatusOutput, AWSError>;
300 /**
301 * Returns the replication configuration of a bucket. It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide. This operation requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies. If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements. For information about GetBucketReplication errors, see ReplicationErrorCodeList The following operations are related to GetBucketReplication: PutBucketReplication DeleteBucketReplication
302 */
303 getBucketReplication(params: S3.Types.GetBucketReplicationRequest, callback?: (err: AWSError, data: S3.Types.GetBucketReplicationOutput) => void): Request<S3.Types.GetBucketReplicationOutput, AWSError>;
304 /**
305 * Returns the replication configuration of a bucket. It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide. This operation requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies. If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements. For information about GetBucketReplication errors, see ReplicationErrorCodeList The following operations are related to GetBucketReplication: PutBucketReplication DeleteBucketReplication
306 */
307 getBucketReplication(callback?: (err: AWSError, data: S3.Types.GetBucketReplicationOutput) => void): Request<S3.Types.GetBucketReplicationOutput, AWSError>;
308 /**
309 * Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets. The following operations are related to GetBucketRequestPayment: ListObjects
310 */
311 getBucketRequestPayment(params: S3.Types.GetBucketRequestPaymentRequest, callback?: (err: AWSError, data: S3.Types.GetBucketRequestPaymentOutput) => void): Request<S3.Types.GetBucketRequestPaymentOutput, AWSError>;
312 /**
313 * Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets. The following operations are related to GetBucketRequestPayment: ListObjects
314 */
315 getBucketRequestPayment(callback?: (err: AWSError, data: S3.Types.GetBucketRequestPaymentOutput) => void): Request<S3.Types.GetBucketRequestPaymentOutput, AWSError>;
316 /**
317 * Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSetError Description: There is no tag set associated with the bucket. The following operations are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging
318 */
319 getBucketTagging(params: S3.Types.GetBucketTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request<S3.Types.GetBucketTaggingOutput, AWSError>;
320 /**
321 * Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. GetBucketTagging has the following special error: Error code: NoSuchTagSetError Description: There is no tag set associated with the bucket. The following operations are related to GetBucketTagging: PutBucketTagging DeleteBucketTagging
322 */
323 getBucketTagging(callback?: (err: AWSError, data: S3.Types.GetBucketTaggingOutput) => void): Request<S3.Types.GetBucketTaggingOutput, AWSError>;
324 /**
325 * Returns the versioning state of a bucket. To retrieve the versioning state of a bucket, you must be the bucket owner. This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket. The following operations are related to GetBucketVersioning: GetObject PutObject DeleteObject
326 */
327 getBucketVersioning(params: S3.Types.GetBucketVersioningRequest, callback?: (err: AWSError, data: S3.Types.GetBucketVersioningOutput) => void): Request<S3.Types.GetBucketVersioningOutput, AWSError>;
328 /**
329 * Returns the versioning state of a bucket. To retrieve the versioning state of a bucket, you must be the bucket owner. This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket. The following operations are related to GetBucketVersioning: GetObject PutObject DeleteObject
330 */
331 getBucketVersioning(callback?: (err: AWSError, data: S3.Types.GetBucketVersioningOutput) => void): Request<S3.Types.GetBucketVersioningOutput, AWSError>;
332 /**
333 * Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3. This GET operation requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission. The following operations are related to DeleteBucketWebsite: DeleteBucketWebsite PutBucketWebsite
334 */
335 getBucketWebsite(params: S3.Types.GetBucketWebsiteRequest, callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request<S3.Types.GetBucketWebsiteOutput, AWSError>;
336 /**
337 * Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3. This GET operation requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission. The following operations are related to DeleteBucketWebsite: DeleteBucketWebsite PutBucketWebsite
338 */
339 getBucketWebsite(callback?: (err: AWSError, data: S3.Types.GetBucketWebsiteOutput) => void): Request<S3.Types.GetBucketWebsiteOutput, AWSError>;
340 /**
341 * Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging action), the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object. Permissions You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. Versioning By default, the GET operation returns the current version of an object. To return a different version, use the versionId subresource. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. For more information about versioning, see PutBucketVersioning. Overriding Response Header Values There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding Additional Considerations about Request Headers If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232. The following operations are related to GetObject: ListBuckets GetObjectAcl
342 */
343 getObject(params: S3.Types.GetObjectRequest, callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
344 /**
345 * Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg. To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification. To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl. If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects. Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging action), the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object. Permissions You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. Versioning By default, the GET operation returns the current version of an object. To return a different version, use the versionId subresource. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response. For more information about versioning, see PutBucketVersioning. Overriding Response Header Values There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. response-content-type response-content-language response-expires response-cache-control response-content-disposition response-content-encoding Additional Considerations about Request Headers If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested. If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232. The following operations are related to GetObject: ListBuckets GetObjectAcl
346 */
347 getObject(callback?: (err: AWSError, data: S3.Types.GetObjectOutput) => void): Request<S3.Types.GetObjectOutput, AWSError>;
348 /**
349 * Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object. Versioning By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. The following operations are related to GetObjectAcl: GetObject DeleteObject PutObject
350 */
351 getObjectAcl(params: S3.Types.GetObjectAclRequest, callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request<S3.Types.GetObjectAclOutput, AWSError>;
352 /**
353 * Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object. Versioning By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. The following operations are related to GetObjectAcl: GetObject DeleteObject PutObject
354 */
355 getObjectAcl(callback?: (err: AWSError, data: S3.Types.GetObjectAclOutput) => void): Request<S3.Types.GetObjectAclOutput, AWSError>;
356 /**
357 * Gets an object's current Legal Hold status. For more information, see Locking Objects.
358 */
359 getObjectLegalHold(params: S3.Types.GetObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request<S3.Types.GetObjectLegalHoldOutput, AWSError>;
360 /**
361 * Gets an object's current Legal Hold status. For more information, see Locking Objects.
362 */
363 getObjectLegalHold(callback?: (err: AWSError, data: S3.Types.GetObjectLegalHoldOutput) => void): Request<S3.Types.GetObjectLegalHoldOutput, AWSError>;
364 /**
365 * Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
366 */
367 getObjectLockConfiguration(params: S3.Types.GetObjectLockConfigurationRequest, callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request<S3.Types.GetObjectLockConfigurationOutput, AWSError>;
368 /**
369 * Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
370 */
371 getObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.GetObjectLockConfigurationOutput) => void): Request<S3.Types.GetObjectLockConfigurationOutput, AWSError>;
372 /**
373 * Retrieves an object's retention settings. For more information, see Locking Objects.
374 */
375 getObjectRetention(params: S3.Types.GetObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request<S3.Types.GetObjectRetentionOutput, AWSError>;
376 /**
377 * Retrieves an object's retention settings. For more information, see Locking Objects.
378 */
379 getObjectRetention(callback?: (err: AWSError, data: S3.Types.GetObjectRetentionOutput) => void): Request<S3.Types.GetObjectRetentionOutput, AWSError>;
380 /**
381 * Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging. The following operation is related to GetObjectTagging: PutObjectTagging
382 */
383 getObjectTagging(params: S3.Types.GetObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request<S3.Types.GetObjectTaggingOutput, AWSError>;
384 /**
385 * Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging. The following operation is related to GetObjectTagging: PutObjectTagging
386 */
387 getObjectTagging(callback?: (err: AWSError, data: S3.Types.GetObjectTaggingOutput) => void): Request<S3.Types.GetObjectTaggingOutput, AWSError>;
388 /**
389 * Return torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Amazon S3 Torrent. You can get torrent only for objects that are less than 5 GB in size and that are not encrypted using server-side encryption with customer-provided encryption key. To use GET, you must have READ access to the object. The following operation is related to GetObjectTorrent: GetObject
390 */
391 getObjectTorrent(params: S3.Types.GetObjectTorrentRequest, callback?: (err: AWSError, data: S3.Types.GetObjectTorrentOutput) => void): Request<S3.Types.GetObjectTorrentOutput, AWSError>;
392 /**
393 * Return torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Amazon S3 Torrent. You can get torrent only for objects that are less than 5 GB in size and that are not encrypted using server-side encryption with customer-provided encryption key. To use GET, you must have READ access to the object. The following operation is related to GetObjectTorrent: GetObject
394 */
395 getObjectTorrent(callback?: (err: AWSError, data: S3.Types.GetObjectTorrentOutput) => void): Request<S3.Types.GetObjectTorrentOutput, AWSError>;
396 /**
397 * Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public". The following operations are related to GetPublicAccessBlock: Using Amazon S3 Block Public Access PutPublicAccessBlock GetPublicAccessBlock DeletePublicAccessBlock
398 */
399 getPublicAccessBlock(params: S3.Types.GetPublicAccessBlockRequest, callback?: (err: AWSError, data: S3.Types.GetPublicAccessBlockOutput) => void): Request<S3.Types.GetPublicAccessBlockOutput, AWSError>;
400 /**
401 * Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public". The following operations are related to GetPublicAccessBlock: Using Amazon S3 Block Public Access PutPublicAccessBlock GetPublicAccessBlock DeletePublicAccessBlock
402 */
403 getPublicAccessBlock(callback?: (err: AWSError, data: S3.Types.GetPublicAccessBlockOutput) => void): Request<S3.Types.GetPublicAccessBlockOutput, AWSError>;
404 /**
405 * This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a 200 OK if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as 404 Not Found and 403 Forbidden. To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
406 */
407 headBucket(params: S3.Types.HeadBucketRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
408 /**
409 * This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a 200 OK if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as 404 Not Found and 403 Forbidden. To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
410 */
411 headBucket(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
412 /**
413 * The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following operation is related to HeadObject: GetObject
414 */
415 headObject(params: S3.Types.HeadObjectRequest, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
416 /**
417 * The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys). Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error. Request headers are limited to 8 KB in size. For more information, see Common Request Headers. Consider the following when using request headers: Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon S3 returns 200 OK and the data requested. Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3 returns the 304 Not Modified response code. For more information about conditional requests, see RFC 7232. Permissions You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. The following operation is related to HeadObject: GetObject
418 */
419 headObject(callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
420 /**
421 * Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis. The following operations are related to ListBucketAnalyticsConfigurations: GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration PutBucketAnalyticsConfiguration
422 */
423 listBucketAnalyticsConfigurations(params: S3.Types.ListBucketAnalyticsConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketAnalyticsConfigurationsOutput) => void): Request<S3.Types.ListBucketAnalyticsConfigurationsOutput, AWSError>;
424 /**
425 * Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis. The following operations are related to ListBucketAnalyticsConfigurations: GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration PutBucketAnalyticsConfiguration
426 */
427 listBucketAnalyticsConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketAnalyticsConfigurationsOutput) => void): Request<S3.Types.ListBucketAnalyticsConfigurationsOutput, AWSError>;
428 /**
429 * Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory The following operations are related to ListBucketInventoryConfigurations: GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration PutBucketInventoryConfiguration
430 */
431 listBucketInventoryConfigurations(params: S3.Types.ListBucketInventoryConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketInventoryConfigurationsOutput) => void): Request<S3.Types.ListBucketInventoryConfigurationsOutput, AWSError>;
432 /**
433 * Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon S3 Inventory The following operations are related to ListBucketInventoryConfigurations: GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration PutBucketInventoryConfiguration
434 */
435 listBucketInventoryConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketInventoryConfigurationsOutput) => void): Request<S3.Types.ListBucketInventoryConfigurationsOutput, AWSError>;
436 /**
437 * Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket. This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to ListBucketMetricsConfigurations: PutBucketMetricsConfiguration GetBucketMetricsConfiguration DeleteBucketMetricsConfiguration
438 */
439 listBucketMetricsConfigurations(params: S3.Types.ListBucketMetricsConfigurationsRequest, callback?: (err: AWSError, data: S3.Types.ListBucketMetricsConfigurationsOutput) => void): Request<S3.Types.ListBucketMetricsConfigurationsOutput, AWSError>;
440 /**
441 * Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket. This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page. To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to ListBucketMetricsConfigurations: PutBucketMetricsConfiguration GetBucketMetricsConfiguration DeleteBucketMetricsConfiguration
442 */
443 listBucketMetricsConfigurations(callback?: (err: AWSError, data: S3.Types.ListBucketMetricsConfigurationsOutput) => void): Request<S3.Types.ListBucketMetricsConfigurationsOutput, AWSError>;
444 /**
445 * Returns a list of all buckets owned by the authenticated sender of the request.
446 */
447 listBuckets(callback?: (err: AWSError, data: S3.Types.ListBucketsOutput) => void): Request<S3.Types.ListBucketsOutput, AWSError>;
448 /**
449 * This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted. This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters. In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions. The following operations are related to ListMultipartUploads: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts AbortMultipartUpload
450 */
451 listMultipartUploads(params: S3.Types.ListMultipartUploadsRequest, callback?: (err: AWSError, data: S3.Types.ListMultipartUploadsOutput) => void): Request<S3.Types.ListMultipartUploadsOutput, AWSError>;
452 /**
453 * This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted. This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters. In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions. The following operations are related to ListMultipartUploads: CreateMultipartUpload UploadPart CompleteMultipartUpload ListParts AbortMultipartUpload
454 */
455 listMultipartUploads(callback?: (err: AWSError, data: S3.Types.ListMultipartUploadsOutput) => void): Request<S3.Types.ListMultipartUploadsOutput, AWSError>;
456 /**
457 * Returns metadata about all of the versions of objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. To use this operation, you must have READ access to the bucket. The following operations are related to ListObjectVersions: ListObjectsV2 GetObject PutObject DeleteObject
458 */
459 listObjectVersions(params: S3.Types.ListObjectVersionsRequest, callback?: (err: AWSError, data: S3.Types.ListObjectVersionsOutput) => void): Request<S3.Types.ListObjectVersionsOutput, AWSError>;
460 /**
461 * Returns metadata about all of the versions of objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. To use this operation, you must have READ access to the bucket. The following operations are related to ListObjectVersions: ListObjectsV2 GetObject PutObject DeleteObject
462 */
463 listObjectVersions(callback?: (err: AWSError, data: S3.Types.ListObjectVersionsOutput) => void): Request<S3.Types.ListObjectVersionsOutput, AWSError>;
464 /**
465 * Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately. This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects. The following operations are related to ListObjects: ListObjectsV2 GetObject PutObject CreateBucket ListBuckets
466 */
467 listObjects(params: S3.Types.ListObjectsRequest, callback?: (err: AWSError, data: S3.Types.ListObjectsOutput) => void): Request<S3.Types.ListObjectsOutput, AWSError>;
468 /**
469 * Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately. This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects. The following operations are related to ListObjects: ListObjectsV2 GetObject PutObject CreateBucket ListBuckets
470 */
471 listObjects(callback?: (err: AWSError, data: S3.Types.ListObjectsOutput) => void): Request<S3.Types.ListObjectsOutput, AWSError>;
472 /**
473 * Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. To use this operation, you must have READ access to the bucket. To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects. To get a list of your buckets, see ListBuckets. The following operations are related to ListObjectsV2: GetObject PutObject CreateBucket
474 */
475 listObjectsV2(params: S3.Types.ListObjectsV2Request, callback?: (err: AWSError, data: S3.Types.ListObjectsV2Output) => void): Request<S3.Types.ListObjectsV2Output, AWSError>;
476 /**
477 * Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. To use this operation, you must have READ access to the bucket. To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects. To get a list of your buckets, see ListBuckets. The following operations are related to ListObjectsV2: GetObject PutObject CreateBucket
478 */
479 listObjectsV2(callback?: (err: AWSError, data: S3.Types.ListObjectsV2Output) => void): Request<S3.Types.ListObjectsV2Output, AWSError>;
480 /**
481 * Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions. The following operations are related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListMultipartUploads
482 */
483 listParts(params: S3.Types.ListPartsRequest, callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request<S3.Types.ListPartsOutput, AWSError>;
484 /**
485 * Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response. For more information on multipart uploads, see Uploading Objects Using Multipart Upload. For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions. The following operations are related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListMultipartUploads
486 */
487 listParts(callback?: (err: AWSError, data: S3.Types.ListPartsOutput) => void): Request<S3.Types.ListPartsOutput, AWSError>;
488 /**
489 * Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3. To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The Transfer Acceleration state of a bucket can be set to one of the following two values: Enabled – Enables accelerated data transfers to the bucket. Suspended – Disables accelerated data transfers to the bucket. The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket. After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase. The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods ("."). For more information about transfer acceleration, see Transfer Acceleration. The following operations are related to PutBucketAccelerateConfiguration: GetBucketAccelerateConfiguration CreateBucket
490 */
491 putBucketAccelerateConfiguration(params: S3.Types.PutBucketAccelerateConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
492 /**
493 * Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3. To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. The Transfer Acceleration state of a bucket can be set to one of the following two values: Enabled – Enables accelerated data transfers to the bucket. Suspended – Disables accelerated data transfers to the bucket. The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket. After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase. The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods ("."). For more information about transfer acceleration, see Transfer Acceleration. The following operations are related to PutBucketAccelerateConfiguration: GetBucketAccelerateConfiguration CreateBucket
494 */
495 putBucketAccelerateConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
496 /**
497 * Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission. You can use one of the following two ways to set a bucket's permissions: Specify the ACL in the request body Specify permissions using request headers You cannot specify access permission using both the body and the request headers. Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach. Access Permissions You can set access permissions using one of the following methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses. x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By Email address: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;lt;/Grantee&gt; The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. By the person's ID: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt; DisplayName is optional and ignored in the request By URI: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt; Related Resources CreateBucket DeleteBucket GetObjectAcl
498 */
499 putBucketAcl(params: S3.Types.PutBucketAclRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
500 /**
501 * Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission. You can use one of the following two ways to set a bucket's permissions: Specify the ACL in the request body Specify permissions using request headers You cannot specify access permission using both the body and the request headers. Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach. Access Permissions You can set access permissions using one of the following methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses. x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By Email address: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;lt;/Grantee&gt; The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. By the person's ID: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt; DisplayName is optional and ignored in the request By URI: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt; Related Resources CreateBucket DeleteBucket GetObjectAcl
502 */
503 putBucketAcl(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
504 /**
505 * Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket. You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis. You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis. To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. Special Errors HTTP Error: HTTP 400 Bad Request Code: InvalidArgument Cause: Invalid argument. HTTP Error: HTTP 400 Bad Request Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP Error: HTTP 403 Forbidden Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket. Related Resources
506 */
507 putBucketAnalyticsConfiguration(params: S3.Types.PutBucketAnalyticsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
508 /**
509 * Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket. You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis. You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis. To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. Special Errors HTTP Error: HTTP 400 Bad Request Code: InvalidArgument Cause: Invalid argument. HTTP Error: HTTP 400 Bad Request Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP Error: HTTP 403 Forbidden Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket. Related Resources
510 */
511 putBucketAnalyticsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
512 /**
513 * Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it. To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others. You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability. To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met: The request's Origin header must match AllowedOrigin elements. The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements. Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element. For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide. Related Resources GetBucketCors DeleteBucketCors RESTOPTIONSobject
514 */
515 putBucketCors(params: S3.Types.PutBucketCorsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
516 /**
517 * Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it. To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others. You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability. To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met: The request's Origin header must match AllowedOrigin elements. The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements. Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element. For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide. Related Resources GetBucketCors DeleteBucketCors RESTOPTIONSobject
518 */
519 putBucketCors(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
520 /**
521 * This implementation of the PUT operation uses the encryption subresource to set the default encryption state of an existing bucket. This implementation of the PUT operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4). To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Related Resources GetBucketEncryption DeleteBucketEncryption
522 */
523 putBucketEncryption(params: S3.Types.PutBucketEncryptionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
524 /**
525 * This implementation of the PUT operation uses the encryption subresource to set the default encryption state of an existing bucket. This implementation of the PUT operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4). To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Related Resources GetBucketEncryption DeleteBucketEncryption
526 */
527 putBucketEncryption(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
528 /**
529 * This implementation of the PUT operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket. When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide. You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis. To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Special Errors HTTP 400 Bad Request Error Code: InvalidArgument Cause: Invalid Argument HTTP 400 Bad Request Error Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP 403 Forbidden Error Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket Related Resources GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration ListBucketInventoryConfigurations
530 */
531 putBucketInventoryConfiguration(params: S3.Types.PutBucketInventoryConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
532 /**
533 * This implementation of the PUT operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket. When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide. You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis. To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Special Errors HTTP 400 Bad Request Error Code: InvalidArgument Cause: Invalid Argument HTTP 400 Bad Request Error Code: TooManyConfigurations Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP 403 Forbidden Error Code: AccessDenied Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket Related Resources GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration ListBucketInventoryConfigurations
534 */
535 putBucketInventoryConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
536 /**
537 * For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide. By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration. Related Resources GetBucketLifecycle(Deprecated) GetBucketLifecycleConfiguration By default, a resource owner—in this case, a bucket owner, which is the AWS account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon Simple Storage Service Developer Guide: Specifying Permissions in a Policy Managing Access Permissions to your Amazon S3 Resources
538 */
539 putBucketLifecycle(params: S3.Types.PutBucketLifecycleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
540 /**
541 * For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide. By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration. Related Resources GetBucketLifecycle(Deprecated) GetBucketLifecycleConfiguration By default, a resource owner—in this case, a bucket owner, which is the AWS account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon Simple Storage Service Developer Guide: Specifying Permissions in a Policy Managing Access Permissions to your Amazon S3 Resources
542 */
543 putBucketLifecycle(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
544 /**
545 * Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle. Rules You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following: Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. Status whether the rule is in effect. One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. For more information, see Object Lifecycle Management and Lifecycle Configuration Elements. Permissions By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources. The following are related to PutBucketLifecycleConfiguration: Examples of Lifecycle Configuration GetBucketLifecycleConfiguration DeleteBucketLifecycle
546 */
547 putBucketLifecycleConfiguration(params: S3.Types.PutBucketLifecycleConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
548 /**
549 * Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle. Rules You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following: Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. Status whether the rule is in effect. One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. For more information, see Object Lifecycle Management and Lifecycle Configuration Elements. Permissions By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: s3:DeleteObject s3:DeleteObjectVersion s3:PutLifecycleConfiguration For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources. The following are related to PutBucketLifecycleConfiguration: Examples of Lifecycle Configuration GetBucketLifecycleConfiguration DeleteBucketLifecycle
550 */
551 putBucketLifecycleConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
552 /**
553 * Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner. The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By the person's ID: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt; DisplayName is optional and ignored in the request. By Email address: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;&lt;/Grantee&gt; The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. By URI: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt; To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element: &lt;BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /&gt; For more information about server access logging, see Server Access Logging. For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging. The following operations are related to PutBucketLogging: PutObject DeleteBucket CreateBucket GetBucketLogging
554 */
555 putBucketLogging(params: S3.Types.PutBucketLoggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
556 /**
557 * Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner. The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By the person's ID: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt; DisplayName is optional and ignored in the request. By Email address: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;&lt;/Grantee&gt; The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. By URI: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt; To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element: &lt;BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /&gt; For more information about server access logging, see Server Access Logging. For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging. The following operations are related to PutBucketLogging: PutObject DeleteBucket CreateBucket GetBucketLogging
558 */
559 putBucketLogging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
560 /**
561 * Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to PutBucketMetricsConfiguration: DeleteBucketMetricsConfiguration PutBucketMetricsConfiguration ListBucketMetricsConfigurations GetBucketLifecycle has the following special error: Error code: TooManyConfigurations Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP Status Code: HTTP 400 Bad Request
562 */
563 putBucketMetricsConfiguration(params: S3.Types.PutBucketMetricsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
564 /**
565 * Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following operations are related to PutBucketMetricsConfiguration: DeleteBucketMetricsConfiguration PutBucketMetricsConfiguration ListBucketMetricsConfigurations GetBucketLifecycle has the following special error: Error code: TooManyConfigurations Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. HTTP Status Code: HTTP 400 Bad Request
566 */
567 putBucketMetricsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
568 /**
569 * No longer used, see the PutBucketNotificationConfiguration operation.
570 */
571 putBucketNotification(params: S3.Types.PutBucketNotificationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
572 /**
573 * No longer used, see the PutBucketNotificationConfiguration operation.
574 */
575 putBucketNotification(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
576 /**
577 * Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration. &lt;NotificationConfiguration&gt; &lt;/NotificationConfiguration&gt; This operation replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket. Responses If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic. The following operation is related to PutBucketNotificationConfiguration: GetBucketNotificationConfiguration
578 */
579 putBucketNotificationConfiguration(params: S3.Types.PutBucketNotificationConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
580 /**
581 * Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications. Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration. &lt;NotificationConfiguration&gt; &lt;/NotificationConfiguration&gt; This operation replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the empty NotificationConfiguration element. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket. Responses If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic. The following operation is related to PutBucketNotificationConfiguration: GetBucketNotificationConfiguration
582 */
583 putBucketNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
584 /**
585 * Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. The following operations are related to PutBucketPolicy: CreateBucket DeleteBucket
586 */
587 putBucketPolicy(params: S3.Types.PutBucketPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
588 /**
589 * Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies. The following operations are related to PutBucketPolicy: CreateBucket DeleteBucket
590 */
591 putBucketPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
592 /**
593 * Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide. To perform this operation, the user or role performing the operation must have the iam:PassRole permission. Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket. To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority. For information about enabling versioning on a bucket, see Using Versioning. By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources. Handling Replication of Encrypted Objects By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS. For information on PutBucketReplication errors, see ReplicationErrorCodeList The following operations are related to PutBucketReplication: GetBucketReplication DeleteBucketReplication
594 */
595 putBucketReplication(params: S3.Types.PutBucketReplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
596 /**
597 * Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide. To perform this operation, the user or role performing the operation must have the iam:PassRole permission. Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket. To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority. For information about enabling versioning on a bucket, see Using Versioning. By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources. Handling Replication of Encrypted Objects By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS. For information on PutBucketReplication errors, see ReplicationErrorCodeList The following operations are related to PutBucketReplication: GetBucketReplication DeleteBucketReplication
598 */
599 putBucketReplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
600 /**
601 * Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets. The following operations are related to PutBucketRequestPayment: CreateBucket GetBucketRequestPayment
602 */
603 putBucketRequestPayment(params: S3.Types.PutBucketRequestPaymentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
604 /**
605 * Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets. The following operations are related to PutBucketRequestPayment: CreateBucket GetBucketRequestPayment
606 */
607 putBucketRequestPayment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
608 /**
609 * Sets the tags for a bucket. Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging. Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags. To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. PutBucketTagging has the following special errors: Error code: InvalidTagError Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions. Error code: MalformedXMLError Description: The XML provided does not match the schema. Error code: OperationAbortedError Description: A conflicting conditional operation is currently in progress against this resource. Please try again. Error code: InternalError Description: The service was unable to apply the provided tag to the bucket. The following operations are related to PutBucketTagging: GetBucketTagging DeleteBucketTagging
610 */
611 putBucketTagging(params: S3.Types.PutBucketTaggingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
612 /**
613 * Sets the tags for a bucket. Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging. Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags. To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources. PutBucketTagging has the following special errors: Error code: InvalidTagError Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions. Error code: MalformedXMLError Description: The XML provided does not match the schema. Error code: OperationAbortedError Description: A conflicting conditional operation is currently in progress against this resource. Please try again. Error code: InternalError Description: The service was unable to apply the provided tag to the bucket. The following operations are related to PutBucketTagging: GetBucketTagging DeleteBucketTagging
614 */
615 putBucketTagging(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
616 /**
617 * Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. You can set the versioning state with one of the following values: Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value. If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket. If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning. Related Resources CreateBucket DeleteBucket GetBucketVersioning
618 */
619 putBucketVersioning(params: S3.Types.PutBucketVersioningRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
620 /**
621 * Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. You can set the versioning state with one of the following values: Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value. If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket. If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning. Related Resources CreateBucket DeleteBucket GetBucketVersioning
622 */
623 putBucketVersioning(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
624 /**
625 * Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3. This PUT operation requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission. To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket. WebsiteConfiguration RedirectAllRequestsTo HostName Protocol If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. WebsiteConfiguration IndexDocument Suffix ErrorDocument Key RoutingRules RoutingRule Condition HttpErrorCodeReturnedEquals KeyPrefixEquals Redirect Protocol HostName ReplaceKeyPrefixWith ReplaceKeyWith HttpRedirectCode
626 */
627 putBucketWebsite(params: S3.Types.PutBucketWebsiteRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
628 /**
629 * Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3. This PUT operation requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission. To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket. WebsiteConfiguration RedirectAllRequestsTo HostName Protocol If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. WebsiteConfiguration IndexDocument Suffix ErrorDocument Key RoutingRules RoutingRule Condition HttpErrorCodeReturnedEquals KeyPrefixEquals Redirect Protocol HostName ReplaceKeyPrefixWith ReplaceKeyWith HttpRedirectCode
630 */
631 putBucketWebsite(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
632 /**
633 * Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it. Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead. To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value. To configure your application to send the request headers before sending the request body, use the 100-continue HTTP status code. For PUT operations, this helps you avoid sending the message body if the message is rejected based on the headers (for example, because authentication fails or a redirect occurs). For more information on the 100-continue HTTP status code, see Section 8.2.3 of http://www.ietf.org/rfc/rfc2616.txt. You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption. Access Permissions You can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the Access Control List (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) EU (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. If you use this feature, the ETag value that Amazon S3 returns in the response is not the MD5 of the object. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Storage Class Options By default, Amazon S3 uses the Standard storage class to store newly created objects. The Standard storage class provides high durability and high availability. You can specify other storage classes depending on the performance needs. For more information, see Storage Classes in the Amazon Simple Storage Service Developer Guide. Versioning If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response using the x-amz-version-id response header. If versioning is suspended, Amazon S3 always uses null as the version ID for the object stored. For more information about returning the versioning state of a bucket, see GetBucketVersioning. If you enable versioning for a bucket, when Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. Related Resources CopyObject DeleteObject
634 */
635 putObject(params: S3.Types.PutObjectRequest, callback?: (err: AWSError, data: S3.Types.PutObjectOutput) => void): Request<S3.Types.PutObjectOutput, AWSError>;
636 /**
637 * Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it. Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead. To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value. To configure your application to send the request headers before sending the request body, use the 100-continue HTTP status code. For PUT operations, this helps you avoid sending the message body if the message is rejected based on the headers (for example, because authentication fails or a redirect occurs). For more information on the 100-continue HTTP status code, see Section 8.2.3 of http://www.ietf.org/rfc/rfc2616.txt. You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption. Access Permissions You can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS. Access-Control-List (ACL)-Specific Request Headers You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the Access Control List (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods: Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL. Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly use: x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-full-control You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) EU (Ireland) South America (São Paulo) For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata: x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key. Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. If you want to use a customer managed AWS KMS CMK, you must provide the x-amz-server-side-encryption-aws-kms-key-id of the symmetric customer managed CMK. Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request. If you use this feature, the ETag value that Amazon S3 returns in the response is not the MD5 of the object. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS. Storage Class Options By default, Amazon S3 uses the Standard storage class to store newly created objects. The Standard storage class provides high durability and high availability. You can specify other storage classes depending on the performance needs. For more information, see Storage Classes in the Amazon Simple Storage Service Developer Guide. Versioning If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response using the x-amz-version-id response header. If versioning is suspended, Amazon S3 always uses null as the version ID for the object stored. For more information about returning the versioning state of a bucket, see GetBucketVersioning. If you enable versioning for a bucket, when Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. Related Resources CopyObject DeleteObject
638 */
639 putObject(callback?: (err: AWSError, data: S3.Types.PutObjectOutput) => void): Request<S3.Types.PutObjectOutput, AWSError>;
640 /**
641 * Uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have WRITE_ACP permission to set the ACL of an object. Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. Access Permissions You can set access permissions using one of the following methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants list objects permission to the two AWS accounts identified by their email addresses. x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By Email address: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;lt;/Grantee&gt; The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. By the person's ID: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt; DisplayName is optional and ignored in the request. By URI: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt; Versioning The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource. Related Resources CopyObject GetObject
642 */
643 putObjectAcl(params: S3.Types.PutObjectAclRequest, callback?: (err: AWSError, data: S3.Types.PutObjectAclOutput) => void): Request<S3.Types.PutObjectAclOutput, AWSError>;
644 /**
645 * Uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have WRITE_ACP permission to set the ACL of an object. Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. Access Permissions You can set access permissions using one of the following methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL. Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. You specify each grantee as a type=value pair, where the type is one of the following: emailAddress – if the value specified is the email address of an AWS account id – if the value specified is the canonical user ID of an AWS account uri – if you are granting permissions to a predefined group For example, the following x-amz-grant-read header grants list objects permission to the two AWS accounts identified by their email addresses. x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" You can use either a canned ACL or specify access permissions explicitly. You cannot do both. Grantee Values You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: By Email address: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;lt;/Grantee&gt; The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. By the person's ID: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt; DisplayName is optional and ignored in the request. By URI: &lt;Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt; Versioning The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource. Related Resources CopyObject GetObject
646 */
647 putObjectAcl(callback?: (err: AWSError, data: S3.Types.PutObjectAclOutput) => void): Request<S3.Types.PutObjectAclOutput, AWSError>;
648 /**
649 * Applies a Legal Hold configuration to the specified object. Related Resources Locking Objects
650 */
651 putObjectLegalHold(params: S3.Types.PutObjectLegalHoldRequest, callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request<S3.Types.PutObjectLegalHoldOutput, AWSError>;
652 /**
653 * Applies a Legal Hold configuration to the specified object. Related Resources Locking Objects
654 */
655 putObjectLegalHold(callback?: (err: AWSError, data: S3.Types.PutObjectLegalHoldOutput) => void): Request<S3.Types.PutObjectLegalHoldOutput, AWSError>;
656 /**
657 * Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. DefaultRetention requires either Days or Years. You can't specify both at the same time. Related Resources Locking Objects
658 */
659 putObjectLockConfiguration(params: S3.Types.PutObjectLockConfigurationRequest, callback?: (err: AWSError, data: S3.Types.PutObjectLockConfigurationOutput) => void): Request<S3.Types.PutObjectLockConfigurationOutput, AWSError>;
660 /**
661 * Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. DefaultRetention requires either Days or Years. You can't specify both at the same time. Related Resources Locking Objects
662 */
663 putObjectLockConfiguration(callback?: (err: AWSError, data: S3.Types.PutObjectLockConfigurationOutput) => void): Request<S3.Types.PutObjectLockConfigurationOutput, AWSError>;
664 /**
665 * Places an Object Retention configuration on an object. Related Resources Locking Objects
666 */
667 putObjectRetention(params: S3.Types.PutObjectRetentionRequest, callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request<S3.Types.PutObjectRetentionOutput, AWSError>;
668 /**
669 * Places an Object Retention configuration on an object. Related Resources Locking Objects
670 */
671 putObjectRetention(callback?: (err: AWSError, data: S3.Types.PutObjectRetentionOutput) => void): Request<S3.Types.PutObjectRetentionOutput, AWSError>;
672 /**
673 * Sets the supplied tag-set to an object that already exists in a bucket A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging. For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object. To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others. To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action. For information about the Amazon S3 object tagging feature, see Object Tagging. Special Errors Code: InvalidTagError Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging. Code: MalformedXMLError Cause: The XML provided does not match the schema. Code: OperationAbortedError Cause: A conflicting conditional operation is currently in progress against this resource. Please try again. Code: InternalError Cause: The service was unable to apply the provided tag to the object. Related Resources GetObjectTagging
674 */
675 putObjectTagging(params: S3.Types.PutObjectTaggingRequest, callback?: (err: AWSError, data: S3.Types.PutObjectTaggingOutput) => void): Request<S3.Types.PutObjectTaggingOutput, AWSError>;
676 /**
677 * Sets the supplied tag-set to an object that already exists in a bucket A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging. For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object. To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others. To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action. For information about the Amazon S3 object tagging feature, see Object Tagging. Special Errors Code: InvalidTagError Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging. Code: MalformedXMLError Cause: The XML provided does not match the schema. Code: OperationAbortedError Cause: A conflicting conditional operation is currently in progress against this resource. Please try again. Code: InternalError Cause: The service was unable to apply the provided tag to the object. Related Resources GetObjectTagging
678 */
679 putObjectTagging(callback?: (err: AWSError, data: S3.Types.PutObjectTaggingOutput) => void): Request<S3.Types.PutObjectTaggingOutput, AWSError>;
680 /**
681 * Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public". Related Resources GetPublicAccessBlock DeletePublicAccessBlock GetBucketPolicyStatus Using Amazon S3 Block Public Access
682 */
683 putPublicAccessBlock(params: S3.Types.PutPublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
684 /**
685 * Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy. When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public". Related Resources GetPublicAccessBlock DeletePublicAccessBlock GetBucketPolicyStatus Using Amazon S3 Block Public Access
686 */
687 putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
688 /**
689 * Restores an archived copy of an object back into Amazon S3 This operation performs the following types of requests: select - Perform a select query on an archived object restore an archive - Restore an archived object To use this operation, you must have permissions to perform the s3:RestoreObject and s3:GetObject actions. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Querying Archives with Select Requests You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide. When making a select request, do the following: Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs in the Amazon Simple Storage Service Developer Guide Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 &gt; 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s For more information about using SQL with Glacier Select restore, see SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide. When making a select request, you can also do the following: To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic. Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results. The following are additional important facts about the select feature: The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy. You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests. Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409. Restoring Archives Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from. To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify. When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body: Expedited - Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class. Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class. Bulk - Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class. For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide. You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new Tier request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the Days request element. For more information, see Upgrading the Speed of an In-Progress Restore in the Amazon Simple Storage Service Developer Guide. To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon Simple Storage Service Developer Guide. After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object. If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon Simple Storage Service Developer Guide. Responses A successful operation returns either the 200 OK or 202 Accepted status code. If the object copy is not previously restored, then Amazon S3 returns 202 Accepted in the response. If the object copy is previously restored, Amazon S3 returns 200 OK in the response. Special Errors Code: RestoreAlreadyInProgress Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.) HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: GlacierExpeditedRetrievalNotAvailable Cause: Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to Standard or Bulk retrievals.) HTTP Status Code: 503 SOAP Fault Code Prefix: N/A Related Resources PutBucketLifecycleConfiguration GetBucketNotificationConfiguration SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide
690 */
691 restoreObject(params: S3.Types.RestoreObjectRequest, callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request<S3.Types.RestoreObjectOutput, AWSError>;
692 /**
693 * Restores an archived copy of an object back into Amazon S3 This operation performs the following types of requests: select - Perform a select query on an archived object restore an archive - Restore an archived object To use this operation, you must have permissions to perform the s3:RestoreObject and s3:GetObject actions. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. Querying Archives with Select Requests You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide. When making a select request, do the following: Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide. For more information about the S3 structure in the request body, see the following: PutObject Managing Access with ACLs in the Amazon Simple Storage Service Developer Guide Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples. The following expression returns all records from the specified object. SELECT * FROM Object Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE s._3 &gt; 100 If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. SELECT s.Id, s.FirstName, s.SSN FROM S3Object s For more information about using SQL with Glacier Select restore, see SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide. When making a select request, you can also do the following: To expedite your queries, specify the Expedited tier. For more information about tiers, see "Restoring Archives," later in this topic. Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results. The following are additional important facts about the select feature: The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy. You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests. Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409. Restoring Archives Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from. To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version. The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify. When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body: Expedited - Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class. Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class. Bulk - Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class. For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide. You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new Tier request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the Days request element. For more information, see Upgrading the Speed of an In-Progress Restore in the Amazon Simple Storage Service Developer Guide. To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon Simple Storage Service Developer Guide. After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object. If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon Simple Storage Service Developer Guide. Responses A successful operation returns either the 200 OK or 202 Accepted status code. If the object copy is not previously restored, then Amazon S3 returns 202 Accepted in the response. If the object copy is previously restored, Amazon S3 returns 200 OK in the response. Special Errors Code: RestoreAlreadyInProgress Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.) HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: GlacierExpeditedRetrievalNotAvailable Cause: Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to Standard or Bulk retrievals.) HTTP Status Code: 503 SOAP Fault Code Prefix: N/A Related Resources PutBucketLifecycleConfiguration GetBucketNotificationConfiguration SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide
694 */
695 restoreObject(callback?: (err: AWSError, data: S3.Types.RestoreObjectOutput) => void): Request<S3.Types.RestoreObjectOutput, AWSError>;
696 /**
697 * This operation filters 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 also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information about Amazon S3 Select, see Selecting Content from Objects in the Amazon Simple Storage Service Developer Guide. For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide. Permissions You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon Simple Storage Service Developer Guide. Object Data Formats You can use Amazon S3 Select to query objects that have the following format properties: CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format. UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports. GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects. Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption. For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon Simple Storage Service Developer Guide. For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide. Working with the Response Body Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see RESTSelectObjectAppendix . GetObject Support The SelectObjectContent operation does not support the following GetObject functionality. For more information, see GetObject. Range: While you can specify a scan range for a Amazon S3 Select request, see SelectObjectContentRequest$ScanRange in the request parameters below, you cannot specify the range of bytes of an object to return. GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon Simple Storage Service Developer Guide. Special Errors For a list of special errors for this operation and for general information about Amazon S3 errors and a list of error codes, see ErrorResponses Related Resources GetObject GetBucketLifecycleConfiguration PutBucketLifecycleConfiguration
698 */
699 selectObjectContent(params: S3.Types.SelectObjectContentRequest, callback?: (err: AWSError, data: S3.Types.SelectObjectContentOutput) => void): Request<S3.Types.SelectObjectContentOutput, AWSError>;
700 /**
701 * This operation filters 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 also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information about Amazon S3 Select, see Selecting Content from Objects in the Amazon Simple Storage Service Developer Guide. For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide. Permissions You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon Simple Storage Service Developer Guide. Object Data Formats You can use Amazon S3 Select to query objects that have the following format properties: CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format. UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports. GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects. Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption. For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon Simple Storage Service Developer Guide. For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide. Working with the Response Body Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see RESTSelectObjectAppendix . GetObject Support The SelectObjectContent operation does not support the following GetObject functionality. For more information, see GetObject. Range: While you can specify a scan range for a Amazon S3 Select request, see SelectObjectContentRequest$ScanRange in the request parameters below, you cannot specify the range of bytes of an object to return. GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon Simple Storage Service Developer Guide. Special Errors For a list of special errors for this operation and for general information about Amazon S3 errors and a list of error codes, see ErrorResponses Related Resources GetObject GetBucketLifecycleConfiguration PutBucketLifecycleConfiguration
702 */
703 selectObjectContent(callback?: (err: AWSError, data: S3.Types.SelectObjectContentOutput) => void): Request<S3.Types.SelectObjectContentOutput, AWSError>;
704 /**
705 * Uploads a part in a multipart upload. In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload. To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. For more information on multipart uploads, go to Multipart Upload Overview in the Amazon Simple Storage Service Developer Guide . For information on the permissions required to use the multipart upload API, go to Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide. You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide. Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload. If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Related Resources CreateMultipartUpload CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
706 */
707 uploadPart(params: S3.Types.UploadPartRequest, callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request<S3.Types.UploadPartOutput, AWSError>;
708 /**
709 * Uploads a part in a multipart upload. In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload. To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. For more information on multipart uploads, go to Multipart Upload Overview in the Amazon Simple Storage Service Developer Guide . For information on the permissions required to use the multipart upload API, go to Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide. You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide. Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload. If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers. x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key x-amz-server-side​-encryption​-customer-key-MD5 Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Related Resources CreateMultipartUpload CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
710 */
711 uploadPart(callback?: (err: AWSError, data: S3.Types.UploadPartOutput) => void): Request<S3.Types.UploadPartOutput, AWSError>;
712 /**
713 * Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request. The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon Simple Storage Service Developer Guide. Instead of using an existing object as part data, you might use the UploadPart operation and provide data in your request. You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request. For more information about using the UploadPartCopy operation, see the following: For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon Simple Storage Service Developer Guide. For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide. For information about copying objects using a single atomic operation vs. the multipart upload, see Operations on Objects in the Amazon Simple Storage Service Developer Guide. For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart. Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since: Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows: x-amz-copy-source-if-match condition evaluates to true, and; x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200 OK and copies the data. Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows: x-amz-copy-source-if-none-match condition evaluates to false, and; x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412 Precondition Failed response code. Versioning If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source. You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example: x-amz-copy-source: /bucket/object?versionId=version id Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found Code: InvalidRequest Cause: The specified copy source is not supported as a byte-range copy source. HTTP Status Code: 400 Bad Request Related Resources CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
714 */
715 uploadPartCopy(params: S3.Types.UploadPartCopyRequest, callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request<S3.Types.UploadPartCopyOutput, AWSError>;
716 /**
717 * Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request. The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon Simple Storage Service Developer Guide. Instead of using an existing object as part data, you might use the UploadPart operation and provide data in your request. You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request. For more information about using the UploadPartCopy operation, see the following: For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon Simple Storage Service Developer Guide. For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide. For information about copying objects using a single atomic operation vs. the multipart upload, see Operations on Objects in the Amazon Simple Storage Service Developer Guide. For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart. Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since: Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows: x-amz-copy-source-if-match condition evaluates to true, and; x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200 OK and copies the data. Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows: x-amz-copy-source-if-none-match condition evaluates to false, and; x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412 Precondition Failed response code. Versioning If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source. You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example: x-amz-copy-source: /bucket/object?versionId=version id Special Errors Code: NoSuchUpload Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found Code: InvalidRequest Cause: The specified copy source is not supported as a byte-range copy source. HTTP Status Code: 400 Bad Request Related Resources CreateMultipartUpload UploadPart CompleteMultipartUpload AbortMultipartUpload ListParts ListMultipartUploads
718 */
719 uploadPartCopy(callback?: (err: AWSError, data: S3.Types.UploadPartCopyOutput) => void): Request<S3.Types.UploadPartCopyOutput, AWSError>;
720 /**
721 * Waits for the bucketExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
722 */
723 waitFor(state: "bucketExists", params: S3.Types.HeadBucketRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
724 /**
725 * Waits for the bucketExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
726 */
727 waitFor(state: "bucketExists", callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
728 /**
729 * Waits for the bucketNotExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
730 */
731 waitFor(state: "bucketNotExists", params: S3.Types.HeadBucketRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
732 /**
733 * Waits for the bucketNotExists state by periodically calling the underlying S3.headBucketoperation every 5 seconds (at most 20 times).
734 */
735 waitFor(state: "bucketNotExists", callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
736 /**
737 * Waits for the objectExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
738 */
739 waitFor(state: "objectExists", params: S3.Types.HeadObjectRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
740 /**
741 * Waits for the objectExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
742 */
743 waitFor(state: "objectExists", callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
744 /**
745 * Waits for the objectNotExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
746 */
747 waitFor(state: "objectNotExists", params: S3.Types.HeadObjectRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
748 /**
749 * Waits for the objectNotExists state by periodically calling the underlying S3.headObjectoperation every 5 seconds (at most 20 times).
750 */
751 waitFor(state: "objectNotExists", callback?: (err: AWSError, data: S3.Types.HeadObjectOutput) => void): Request<S3.Types.HeadObjectOutput, AWSError>;
752}
753declare namespace S3 {
754 export import ManagedUpload = managed_upload;
755 export import PresignedPost = presigned_post;
756}
757declare namespace S3 {
758 export type AbortDate = Date;
759 export interface AbortIncompleteMultipartUpload {
760 /**
761 * Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.
762 */
763 DaysAfterInitiation?: DaysAfterInitiation;
764 }
765 export interface AbortMultipartUploadOutput {
766 RequestCharged?: RequestCharged;
767 }
768 export interface AbortMultipartUploadRequest {
769 /**
770 * The bucket name to which the upload was taking place. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
771 */
772 Bucket: BucketName;
773 /**
774 * Key of the object for which the multipart upload was initiated.
775 */
776 Key: ObjectKey;
777 /**
778 * Upload ID that identifies the multipart upload.
779 */
780 UploadId: MultipartUploadId;
781 RequestPayer?: RequestPayer;
782 }
783 export type AbortRuleId = string;
784 export interface AccelerateConfiguration {
785 /**
786 * Specifies the transfer acceleration status of the bucket.
787 */
788 Status?: BucketAccelerateStatus;
789 }
790 export type AcceptRanges = string;
791 export interface AccessControlPolicy {
792 /**
793 * A list of grants.
794 */
795 Grants?: Grants;
796 /**
797 * Container for the bucket owner's display name and ID.
798 */
799 Owner?: Owner;
800 }
801 export interface AccessControlTranslation {
802 /**
803 * Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon Simple Storage Service API Reference.
804 */
805 Owner: OwnerOverride;
806 }
807 export type AccountId = string;
808 export type AllowQuotedRecordDelimiter = boolean;
809 export type AllowedHeader = string;
810 export type AllowedHeaders = AllowedHeader[];
811 export type AllowedMethod = string;
812 export type AllowedMethods = AllowedMethod[];
813 export type AllowedOrigin = string;
814 export type AllowedOrigins = AllowedOrigin[];
815 export interface AnalyticsAndOperator {
816 /**
817 * The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.
818 */
819 Prefix?: Prefix;
820 /**
821 * The list of tags to use when evaluating an AND predicate.
822 */
823 Tags?: TagSet;
824 }
825 export interface AnalyticsConfiguration {
826 /**
827 * The ID that identifies the analytics configuration.
828 */
829 Id: AnalyticsId;
830 /**
831 * The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
832 */
833 Filter?: AnalyticsFilter;
834 /**
835 * Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.
836 */
837 StorageClassAnalysis: StorageClassAnalysis;
838 }
839 export type AnalyticsConfigurationList = AnalyticsConfiguration[];
840 export interface AnalyticsExportDestination {
841 /**
842 * A destination signifying output to an S3 bucket.
843 */
844 S3BucketDestination: AnalyticsS3BucketDestination;
845 }
846 export interface AnalyticsFilter {
847 /**
848 * The prefix to use when evaluating an analytics filter.
849 */
850 Prefix?: Prefix;
851 /**
852 * The tag to use when evaluating an analytics filter.
853 */
854 Tag?: Tag;
855 /**
856 * A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.
857 */
858 And?: AnalyticsAndOperator;
859 }
860 export type AnalyticsId = string;
861 export interface AnalyticsS3BucketDestination {
862 /**
863 * Specifies the file format used when exporting data to Amazon S3.
864 */
865 Format: AnalyticsS3ExportFileFormat;
866 /**
867 * The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data.
868 */
869 BucketAccountId?: AccountId;
870 /**
871 * The Amazon Resource Name (ARN) of the bucket to which data is exported.
872 */
873 Bucket: BucketName;
874 /**
875 * The prefix to use when exporting data. The prefix is prepended to all results.
876 */
877 Prefix?: Prefix;
878 }
879 export type AnalyticsS3ExportFileFormat = "CSV"|string;
880 export type Body = Buffer|Uint8Array|Blob|string|Readable;
881 export interface Bucket {
882 /**
883 * The name of the bucket.
884 */
885 Name?: BucketName;
886 /**
887 * Date the bucket was created.
888 */
889 CreationDate?: CreationDate;
890 }
891 export type BucketAccelerateStatus = "Enabled"|"Suspended"|string;
892 export type BucketCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|string;
893 export interface BucketLifecycleConfiguration {
894 /**
895 * A lifecycle rule for individual objects in an Amazon S3 bucket.
896 */
897 Rules: LifecycleRules;
898 }
899 export type BucketLocationConstraint = "EU"|"eu-west-1"|"us-west-1"|"us-west-2"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"sa-east-1"|"cn-north-1"|"eu-central-1"|string;
900 export interface BucketLoggingStatus {
901 LoggingEnabled?: LoggingEnabled;
902 }
903 export type BucketLogsPermission = "FULL_CONTROL"|"READ"|"WRITE"|string;
904 export type BucketName = string;
905 export type BucketVersioningStatus = "Enabled"|"Suspended"|string;
906 export type Buckets = Bucket[];
907 export type BypassGovernanceRetention = boolean;
908 export type BytesProcessed = number;
909 export type BytesReturned = number;
910 export type BytesScanned = number;
911 export interface CORSConfiguration {
912 /**
913 * A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
914 */
915 CORSRules: CORSRules;
916 }
917 export interface CORSRule {
918 /**
919 * Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.
920 */
921 AllowedHeaders?: AllowedHeaders;
922 /**
923 * An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.
924 */
925 AllowedMethods: AllowedMethods;
926 /**
927 * One or more origins you want customers to be able to access the bucket from.
928 */
929 AllowedOrigins: AllowedOrigins;
930 /**
931 * One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
932 */
933 ExposeHeaders?: ExposeHeaders;
934 /**
935 * The time in seconds that your browser is to cache the preflight response for the specified resource.
936 */
937 MaxAgeSeconds?: MaxAgeSeconds;
938 }
939 export type CORSRules = CORSRule[];
940 export interface CSVInput {
941 /**
942 * Describes the first line of input. Valid values are: NONE: First line is not a header. IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s). Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).
943 */
944 FileHeaderInfo?: FileHeaderInfo;
945 /**
946 * 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.
947 */
948 Comments?: Comments;
949 /**
950 * 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 ".
951 */
952 QuoteEscapeCharacter?: QuoteEscapeCharacter;
953 /**
954 * A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.
955 */
956 RecordDelimiter?: RecordDelimiter;
957 /**
958 * A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.
959 */
960 FieldDelimiter?: FieldDelimiter;
961 /**
962 * A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ". Type: String Default: " Ancestors: CSV
963 */
964 QuoteCharacter?: QuoteCharacter;
965 /**
966 * 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.
967 */
968 AllowQuotedRecordDelimiter?: AllowQuotedRecordDelimiter;
969 }
970 export interface CSVOutput {
971 /**
972 * Indicates whether to use quotation marks around output fields. ALWAYS: Always use quotation marks for output fields. ASNEEDED: Use quotation marks for output fields when needed.
973 */
974 QuoteFields?: QuoteFields;
975 /**
976 * The single character used for escaping the quote character inside an already escaped value.
977 */
978 QuoteEscapeCharacter?: QuoteEscapeCharacter;
979 /**
980 * A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
981 */
982 RecordDelimiter?: RecordDelimiter;
983 /**
984 * The value used to separate individual fields in a record. You can specify an arbitrary delimiter.
985 */
986 FieldDelimiter?: FieldDelimiter;
987 /**
988 * A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".
989 */
990 QuoteCharacter?: QuoteCharacter;
991 }
992 export type CacheControl = string;
993 export type CloudFunction = string;
994 export interface CloudFunctionConfiguration {
995 Id?: NotificationId;
996 Event?: Event;
997 /**
998 * Bucket events for which to send notifications.
999 */
1000 Events?: EventList;
1001 /**
1002 * Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.
1003 */
1004 CloudFunction?: CloudFunction;
1005 /**
1006 * The role supporting the invocation of the Lambda function
1007 */
1008 InvocationRole?: CloudFunctionInvocationRole;
1009 }
1010 export type CloudFunctionInvocationRole = string;
1011 export type Code = string;
1012 export type Comments = string;
1013 export interface CommonPrefix {
1014 /**
1015 * Container for the specified common prefix.
1016 */
1017 Prefix?: Prefix;
1018 }
1019 export type CommonPrefixList = CommonPrefix[];
1020 export interface CompleteMultipartUploadOutput {
1021 /**
1022 * The URI that identifies the newly created object.
1023 */
1024 Location?: Location;
1025 /**
1026 * The name of the bucket that contains the newly created object.
1027 */
1028 Bucket?: BucketName;
1029 /**
1030 * The object key of the newly created object.
1031 */
1032 Key?: ObjectKey;
1033 /**
1034 * If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
1035 */
1036 Expiration?: Expiration;
1037 /**
1038 * Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.
1039 */
1040 ETag?: ETag;
1041 /**
1042 * If you specified server-side encryption either with an Amazon S3-managed encryption key or an AWS KMS customer master key (CMK) in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
1043 */
1044 ServerSideEncryption?: ServerSideEncryption;
1045 /**
1046 * Version ID of the newly created object, in case the bucket has versioning turned on.
1047 */
1048 VersionId?: ObjectVersionId;
1049 /**
1050 * 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.
1051 */
1052 SSEKMSKeyId?: SSEKMSKeyId;
1053 RequestCharged?: RequestCharged;
1054 }
1055 export interface CompleteMultipartUploadRequest {
1056 /**
1057 * Name of the bucket to which the multipart upload was initiated.
1058 */
1059 Bucket: BucketName;
1060 /**
1061 * Object key for which the multipart upload was initiated.
1062 */
1063 Key: ObjectKey;
1064 /**
1065 * The container for the multipart upload request information.
1066 */
1067 MultipartUpload?: CompletedMultipartUpload;
1068 /**
1069 * ID for the initiated multipart upload.
1070 */
1071 UploadId: MultipartUploadId;
1072 RequestPayer?: RequestPayer;
1073 }
1074 export interface CompletedMultipartUpload {
1075 /**
1076 * Array of CompletedPart data types.
1077 */
1078 Parts?: CompletedPartList;
1079 }
1080 export interface CompletedPart {
1081 /**
1082 * Entity tag returned when the part was uploaded.
1083 */
1084 ETag?: ETag;
1085 /**
1086 * Part number that identifies the part. This is a positive integer between 1 and 10,000.
1087 */
1088 PartNumber?: PartNumber;
1089 }
1090 export type CompletedPartList = CompletedPart[];
1091 export type CompressionType = "NONE"|"GZIP"|"BZIP2"|string;
1092 export interface Condition {
1093 /**
1094 * The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.
1095 */
1096 HttpErrorCodeReturnedEquals?: HttpErrorCodeReturnedEquals;
1097 /**
1098 * The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.
1099 */
1100 KeyPrefixEquals?: KeyPrefixEquals;
1101 }
1102 export type ConfirmRemoveSelfBucketAccess = boolean;
1103 export type ContentDisposition = string;
1104 export type ContentEncoding = string;
1105 export type ContentLanguage = string;
1106 export type ContentLength = number;
1107 export type ContentMD5 = string;
1108 export type ContentRange = string;
1109 export type ContentType = string;
1110 export interface ContinuationEvent {
1111 }
1112 export interface CopyObjectOutput {
1113 /**
1114 * Container for all response elements.
1115 */
1116 CopyObjectResult?: CopyObjectResult;
1117 /**
1118 * If the object expiration is configured, the response includes this header.
1119 */
1120 Expiration?: Expiration;
1121 /**
1122 * Version of the copied object in the destination bucket.
1123 */
1124 CopySourceVersionId?: CopySourceVersionId;
1125 /**
1126 * Version ID of the newly created copy.
1127 */
1128 VersionId?: ObjectVersionId;
1129 /**
1130 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
1131 */
1132 ServerSideEncryption?: ServerSideEncryption;
1133 /**
1134 * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
1135 */
1136 SSECustomerAlgorithm?: SSECustomerAlgorithm;
1137 /**
1138 * 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.
1139 */
1140 SSECustomerKeyMD5?: SSECustomerKeyMD5;
1141 /**
1142 * 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.
1143 */
1144 SSEKMSKeyId?: SSEKMSKeyId;
1145 /**
1146 * If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
1147 */
1148 SSEKMSEncryptionContext?: SSEKMSEncryptionContext;
1149 RequestCharged?: RequestCharged;
1150 }
1151 export interface CopyObjectRequest {
1152 /**
1153 * The canned ACL to apply to the object.
1154 */
1155 ACL?: ObjectCannedACL;
1156 /**
1157 * The name of the destination bucket.
1158 */
1159 Bucket: BucketName;
1160 /**
1161 * Specifies caching behavior along the request/reply chain.
1162 */
1163 CacheControl?: CacheControl;
1164 /**
1165 * Specifies presentational information for the object.
1166 */
1167 ContentDisposition?: ContentDisposition;
1168 /**
1169 * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
1170 */
1171 ContentEncoding?: ContentEncoding;
1172 /**
1173 * The language the content is in.
1174 */
1175 ContentLanguage?: ContentLanguage;
1176 /**
1177 * A standard MIME type describing the format of the object data.
1178 */
1179 ContentType?: ContentType;
1180 /**
1181 * The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
1182 */
1183 CopySource: CopySource;
1184 /**
1185 * Copies the object if its entity tag (ETag) matches the specified tag.
1186 */
1187 CopySourceIfMatch?: CopySourceIfMatch;
1188 /**
1189 * Copies the object if it has been modified since the specified time.
1190 */
1191 CopySourceIfModifiedSince?: CopySourceIfModifiedSince;
1192 /**
1193 * Copies the object if its entity tag (ETag) is different than the specified ETag.
1194 */
1195 CopySourceIfNoneMatch?: CopySourceIfNoneMatch;
1196 /**
1197 * Copies the object if it hasn't been modified since the specified time.
1198 */
1199 CopySourceIfUnmodifiedSince?: CopySourceIfUnmodifiedSince;
1200 /**
1201 * The date and time at which the object is no longer cacheable.
1202 */
1203 Expires?: Expires;
1204 /**
1205 * Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
1206 */
1207 GrantFullControl?: GrantFullControl;
1208 /**
1209 * Allows grantee to read the object data and its metadata.
1210 */
1211 GrantRead?: GrantRead;
1212 /**
1213 * Allows grantee to read the object ACL.
1214 */
1215 GrantReadACP?: GrantReadACP;
1216 /**
1217 * Allows grantee to write the ACL for the applicable object.
1218 */
1219 GrantWriteACP?: GrantWriteACP;
1220 /**
1221 * The key of the destination object.
1222 */
1223 Key: ObjectKey;
1224 /**
1225 * A map of metadata to store with the object in S3.
1226 */
1227 Metadata?: Metadata;
1228 /**
1229 * Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
1230 */
1231 MetadataDirective?: MetadataDirective;
1232 /**
1233 * Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
1234 */
1235 TaggingDirective?: TaggingDirective;
1236 /**
1237 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
1238 */
1239 ServerSideEncryption?: ServerSideEncryption;
1240 /**
1241 * The type of storage to use for the object. Defaults to 'STANDARD'.
1242 */
1243 StorageClass?: StorageClass;
1244 /**
1245 * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
1246 */
1247 WebsiteRedirectLocation?: WebsiteRedirectLocation;
1248 /**
1249 * Specifies the algorithm to use to when encrypting the object (for example, AES256).
1250 */
1251 SSECustomerAlgorithm?: SSECustomerAlgorithm;
1252 /**
1253 * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
1254 */
1255 SSECustomerKey?: SSECustomerKey;
1256 /**
1257 * 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.
1258 */
1259 SSECustomerKeyMD5?: SSECustomerKeyMD5;
1260 /**
1261 * Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.
1262 */
1263 SSEKMSKeyId?: SSEKMSKeyId;
1264 /**
1265 * Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
1266 */
1267 SSEKMSEncryptionContext?: SSEKMSEncryptionContext;
1268 /**
1269 * Specifies the algorithm to use when decrypting the source object (for example, AES256).
1270 */
1271 CopySourceSSECustomerAlgorithm?: CopySourceSSECustomerAlgorithm;
1272 /**
1273 * 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.
1274 */
1275 CopySourceSSECustomerKey?: CopySourceSSECustomerKey;
1276 /**
1277 * 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.
1278 */
1279 CopySourceSSECustomerKeyMD5?: CopySourceSSECustomerKeyMD5;
1280 RequestPayer?: RequestPayer;
1281 /**
1282 * The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.
1283 */
1284 Tagging?: TaggingHeader;
1285 /**
1286 * The Object Lock mode that you want to apply to the copied object.
1287 */
1288 ObjectLockMode?: ObjectLockMode;
1289 /**
1290 * The date and time when you want the copied object's Object Lock to expire.
1291 */
1292 ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
1293 /**
1294 * Specifies whether you want to apply a Legal Hold to the copied object.
1295 */
1296 ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
1297 }
1298 export interface CopyObjectResult {
1299 /**
1300 * Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata. The source and destination ETag is identical for a successfully copied object.
1301 */
1302 ETag?: ETag;
1303 /**
1304 * Returns the date that the object was last modified.
1305 */
1306 LastModified?: LastModified;
1307 }
1308 export interface CopyPartResult {
1309 /**
1310 * Entity tag of the object.
1311 */
1312 ETag?: ETag;
1313 /**
1314 * Date and time at which the object was uploaded.
1315 */
1316 LastModified?: LastModified;
1317 }
1318 export type CopySource = string;
1319 export type CopySourceIfMatch = string;
1320 export type CopySourceIfModifiedSince = Date;
1321 export type CopySourceIfNoneMatch = string;
1322 export type CopySourceIfUnmodifiedSince = Date;
1323 export type CopySourceRange = string;
1324 export type CopySourceSSECustomerAlgorithm = string;
1325 export type CopySourceSSECustomerKey = Buffer|Uint8Array|Blob|string;
1326 export type CopySourceSSECustomerKeyMD5 = string;
1327 export type CopySourceVersionId = string;
1328 export interface CreateBucketConfiguration {
1329 /**
1330 * Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).
1331 */
1332 LocationConstraint?: BucketLocationConstraint;
1333 }
1334 export interface CreateBucketOutput {
1335 /**
1336 * Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.
1337 */
1338 Location?: Location;
1339 }
1340 export interface CreateBucketRequest {
1341 /**
1342 * The canned ACL to apply to the bucket.
1343 */
1344 ACL?: BucketCannedACL;
1345 /**
1346 * The name of the bucket to create.
1347 */
1348 Bucket: BucketName;
1349 /**
1350 * The configuration information for the bucket.
1351 */
1352 CreateBucketConfiguration?: CreateBucketConfiguration;
1353 /**
1354 * Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
1355 */
1356 GrantFullControl?: GrantFullControl;
1357 /**
1358 * Allows grantee to list the objects in the bucket.
1359 */
1360 GrantRead?: GrantRead;
1361 /**
1362 * Allows grantee to read the bucket ACL.
1363 */
1364 GrantReadACP?: GrantReadACP;
1365 /**
1366 * Allows grantee to create, overwrite, and delete any object in the bucket.
1367 */
1368 GrantWrite?: GrantWrite;
1369 /**
1370 * Allows grantee to write the ACL for the applicable bucket.
1371 */
1372 GrantWriteACP?: GrantWriteACP;
1373 /**
1374 * Specifies whether you want S3 Object Lock to be enabled for the new bucket.
1375 */
1376 ObjectLockEnabledForBucket?: ObjectLockEnabledForBucket;
1377 }
1378 export interface CreateMultipartUploadOutput {
1379 /**
1380 * If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.
1381 */
1382 AbortDate?: AbortDate;
1383 /**
1384 * This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
1385 */
1386 AbortRuleId?: AbortRuleId;
1387 /**
1388 * 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
1389 */
1390 Bucket?: BucketName;
1391 /**
1392 * Object key for which the multipart upload was initiated.
1393 */
1394 Key?: ObjectKey;
1395 /**
1396 * ID for the initiated multipart upload.
1397 */
1398 UploadId?: MultipartUploadId;
1399 /**
1400 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
1401 */
1402 ServerSideEncryption?: ServerSideEncryption;
1403 /**
1404 * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
1405 */
1406 SSECustomerAlgorithm?: SSECustomerAlgorithm;
1407 /**
1408 * 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.
1409 */
1410 SSECustomerKeyMD5?: SSECustomerKeyMD5;
1411 /**
1412 * 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.
1413 */
1414 SSEKMSKeyId?: SSEKMSKeyId;
1415 /**
1416 * If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
1417 */
1418 SSEKMSEncryptionContext?: SSEKMSEncryptionContext;
1419 RequestCharged?: RequestCharged;
1420 }
1421 export interface CreateMultipartUploadRequest {
1422 /**
1423 * The canned ACL to apply to the object.
1424 */
1425 ACL?: ObjectCannedACL;
1426 /**
1427 * The name of the bucket to which to initiate the upload
1428 */
1429 Bucket: BucketName;
1430 /**
1431 * Specifies caching behavior along the request/reply chain.
1432 */
1433 CacheControl?: CacheControl;
1434 /**
1435 * Specifies presentational information for the object.
1436 */
1437 ContentDisposition?: ContentDisposition;
1438 /**
1439 * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
1440 */
1441 ContentEncoding?: ContentEncoding;
1442 /**
1443 * The language the content is in.
1444 */
1445 ContentLanguage?: ContentLanguage;
1446 /**
1447 * A standard MIME type describing the format of the object data.
1448 */
1449 ContentType?: ContentType;
1450 /**
1451 * The date and time at which the object is no longer cacheable.
1452 */
1453 Expires?: Expires;
1454 /**
1455 * Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
1456 */
1457 GrantFullControl?: GrantFullControl;
1458 /**
1459 * Allows grantee to read the object data and its metadata.
1460 */
1461 GrantRead?: GrantRead;
1462 /**
1463 * Allows grantee to read the object ACL.
1464 */
1465 GrantReadACP?: GrantReadACP;
1466 /**
1467 * Allows grantee to write the ACL for the applicable object.
1468 */
1469 GrantWriteACP?: GrantWriteACP;
1470 /**
1471 * Object key for which the multipart upload is to be initiated.
1472 */
1473 Key: ObjectKey;
1474 /**
1475 * A map of metadata to store with the object in S3.
1476 */
1477 Metadata?: Metadata;
1478 /**
1479 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
1480 */
1481 ServerSideEncryption?: ServerSideEncryption;
1482 /**
1483 * The type of storage to use for the object. Defaults to 'STANDARD'.
1484 */
1485 StorageClass?: StorageClass;
1486 /**
1487 * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
1488 */
1489 WebsiteRedirectLocation?: WebsiteRedirectLocation;
1490 /**
1491 * Specifies the algorithm to use to when encrypting the object (for example, AES256).
1492 */
1493 SSECustomerAlgorithm?: SSECustomerAlgorithm;
1494 /**
1495 * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
1496 */
1497 SSECustomerKey?: SSECustomerKey;
1498 /**
1499 * 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.
1500 */
1501 SSECustomerKeyMD5?: SSECustomerKeyMD5;
1502 /**
1503 * Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.
1504 */
1505 SSEKMSKeyId?: SSEKMSKeyId;
1506 /**
1507 * Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
1508 */
1509 SSEKMSEncryptionContext?: SSEKMSEncryptionContext;
1510 RequestPayer?: RequestPayer;
1511 /**
1512 * The tag-set for the object. The tag-set must be encoded as URL Query parameters.
1513 */
1514 Tagging?: TaggingHeader;
1515 /**
1516 * Specifies the Object Lock mode that you want to apply to the uploaded object.
1517 */
1518 ObjectLockMode?: ObjectLockMode;
1519 /**
1520 * Specifies the date and time when you want the Object Lock to expire.
1521 */
1522 ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
1523 /**
1524 * Specifies whether you want to apply a Legal Hold to the uploaded object.
1525 */
1526 ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
1527 }
1528 export type CreationDate = Date;
1529 export type _Date = Date;
1530 export type Days = number;
1531 export type DaysAfterInitiation = number;
1532 export interface DefaultRetention {
1533 /**
1534 * The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.
1535 */
1536 Mode?: ObjectLockRetentionMode;
1537 /**
1538 * The number of days that you want to specify for the default retention period.
1539 */
1540 Days?: Days;
1541 /**
1542 * The number of years that you want to specify for the default retention period.
1543 */
1544 Years?: Years;
1545 }
1546 export interface Delete {
1547 /**
1548 * The objects to delete.
1549 */
1550 Objects: ObjectIdentifierList;
1551 /**
1552 * Element to enable quiet mode for the request. When you add this element, you must set its value to true.
1553 */
1554 Quiet?: Quiet;
1555 }
1556 export interface DeleteBucketAnalyticsConfigurationRequest {
1557 /**
1558 * The name of the bucket from which an analytics configuration is deleted.
1559 */
1560 Bucket: BucketName;
1561 /**
1562 * The ID that identifies the analytics configuration.
1563 */
1564 Id: AnalyticsId;
1565 }
1566 export interface DeleteBucketCorsRequest {
1567 /**
1568 * Specifies the bucket whose cors configuration is being deleted.
1569 */
1570 Bucket: BucketName;
1571 }
1572 export interface DeleteBucketEncryptionRequest {
1573 /**
1574 * The name of the bucket containing the server-side encryption configuration to delete.
1575 */
1576 Bucket: BucketName;
1577 }
1578 export interface DeleteBucketInventoryConfigurationRequest {
1579 /**
1580 * The name of the bucket containing the inventory configuration to delete.
1581 */
1582 Bucket: BucketName;
1583 /**
1584 * The ID used to identify the inventory configuration.
1585 */
1586 Id: InventoryId;
1587 }
1588 export interface DeleteBucketLifecycleRequest {
1589 /**
1590 * The bucket name of the lifecycle to delete.
1591 */
1592 Bucket: BucketName;
1593 }
1594 export interface DeleteBucketMetricsConfigurationRequest {
1595 /**
1596 * The name of the bucket containing the metrics configuration to delete.
1597 */
1598 Bucket: BucketName;
1599 /**
1600 * The ID used to identify the metrics configuration.
1601 */
1602 Id: MetricsId;
1603 }
1604 export interface DeleteBucketPolicyRequest {
1605 /**
1606 * The bucket name.
1607 */
1608 Bucket: BucketName;
1609 }
1610 export interface DeleteBucketReplicationRequest {
1611 /**
1612 * The bucket name.
1613 */
1614 Bucket: BucketName;
1615 }
1616 export interface DeleteBucketRequest {
1617 /**
1618 * Specifies the bucket being deleted.
1619 */
1620 Bucket: BucketName;
1621 }
1622 export interface DeleteBucketTaggingRequest {
1623 /**
1624 * The bucket that has the tag set to be removed.
1625 */
1626 Bucket: BucketName;
1627 }
1628 export interface DeleteBucketWebsiteRequest {
1629 /**
1630 * The bucket name for which you want to remove the website configuration.
1631 */
1632 Bucket: BucketName;
1633 }
1634 export type DeleteMarker = boolean;
1635 export interface DeleteMarkerEntry {
1636 /**
1637 * The account that created the delete marker.&gt;
1638 */
1639 Owner?: Owner;
1640 /**
1641 * The object key.
1642 */
1643 Key?: ObjectKey;
1644 /**
1645 * Version ID of an object.
1646 */
1647 VersionId?: ObjectVersionId;
1648 /**
1649 * Specifies whether the object is (true) or is not (false) the latest version of an object.
1650 */
1651 IsLatest?: IsLatest;
1652 /**
1653 * Date and time the object was last modified.
1654 */
1655 LastModified?: LastModified;
1656 }
1657 export interface DeleteMarkerReplication {
1658 /**
1659 * Indicates whether to replicate delete markers. In the current implementation, Amazon S3 doesn't replicate the delete markers. The status must be Disabled.
1660 */
1661 Status?: DeleteMarkerReplicationStatus;
1662 }
1663 export type DeleteMarkerReplicationStatus = "Enabled"|"Disabled"|string;
1664 export type DeleteMarkerVersionId = string;
1665 export type DeleteMarkers = DeleteMarkerEntry[];
1666 export interface DeleteObjectOutput {
1667 /**
1668 * Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
1669 */
1670 DeleteMarker?: DeleteMarker;
1671 /**
1672 * Returns the version ID of the delete marker created as a result of the DELETE operation.
1673 */
1674 VersionId?: ObjectVersionId;
1675 RequestCharged?: RequestCharged;
1676 }
1677 export interface DeleteObjectRequest {
1678 /**
1679 * The bucket name of the bucket containing the object. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
1680 */
1681 Bucket: BucketName;
1682 /**
1683 * Key name of the object to delete.
1684 */
1685 Key: ObjectKey;
1686 /**
1687 * The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
1688 */
1689 MFA?: MFA;
1690 /**
1691 * VersionId used to reference a specific version of the object.
1692 */
1693 VersionId?: ObjectVersionId;
1694 RequestPayer?: RequestPayer;
1695 /**
1696 * Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
1697 */
1698 BypassGovernanceRetention?: BypassGovernanceRetention;
1699 }
1700 export interface DeleteObjectTaggingOutput {
1701 /**
1702 * The versionId of the object the tag-set was removed from.
1703 */
1704 VersionId?: ObjectVersionId;
1705 }
1706 export interface DeleteObjectTaggingRequest {
1707 /**
1708 * The bucket name containing the objects from which to remove the tags. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
1709 */
1710 Bucket: BucketName;
1711 /**
1712 * Name of the tag.
1713 */
1714 Key: ObjectKey;
1715 /**
1716 * The versionId of the object that the tag-set will be removed from.
1717 */
1718 VersionId?: ObjectVersionId;
1719 }
1720 export interface DeleteObjectsOutput {
1721 /**
1722 * Container element for a successful delete. It identifies the object that was successfully deleted.
1723 */
1724 Deleted?: DeletedObjects;
1725 RequestCharged?: RequestCharged;
1726 /**
1727 * Container for a failed delete operation that describes the object that Amazon S3 attempted to delete and the error it encountered.
1728 */
1729 Errors?: Errors;
1730 }
1731 export interface DeleteObjectsRequest {
1732 /**
1733 * The bucket name containing the objects to delete. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
1734 */
1735 Bucket: BucketName;
1736 /**
1737 * Container for the request.
1738 */
1739 Delete: Delete;
1740 /**
1741 * The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
1742 */
1743 MFA?: MFA;
1744 RequestPayer?: RequestPayer;
1745 /**
1746 * Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.
1747 */
1748 BypassGovernanceRetention?: BypassGovernanceRetention;
1749 }
1750 export interface DeletePublicAccessBlockRequest {
1751 /**
1752 * The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.
1753 */
1754 Bucket: BucketName;
1755 }
1756 export interface DeletedObject {
1757 /**
1758 * The name of the deleted object.
1759 */
1760 Key?: ObjectKey;
1761 /**
1762 * The version ID of the deleted object.
1763 */
1764 VersionId?: ObjectVersionId;
1765 /**
1766 * Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.
1767 */
1768 DeleteMarker?: DeleteMarker;
1769 /**
1770 * The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.
1771 */
1772 DeleteMarkerVersionId?: DeleteMarkerVersionId;
1773 }
1774 export type DeletedObjects = DeletedObject[];
1775 export type Delimiter = string;
1776 export type Description = string;
1777 export interface Destination {
1778 /**
1779 * The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
1780 */
1781 Bucket: BucketName;
1782 /**
1783 * Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Changing the Replica Owner in the Amazon Simple Storage Service Developer Guide.
1784 */
1785 Account?: AccountId;
1786 /**
1787 * The storage class to use when replicating objects, such as standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon Simple Storage Service API Reference.
1788 */
1789 StorageClass?: StorageClass;
1790 /**
1791 * Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.
1792 */
1793 AccessControlTranslation?: AccessControlTranslation;
1794 /**
1795 * A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.
1796 */
1797 EncryptionConfiguration?: EncryptionConfiguration;
1798 /**
1799 * A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.
1800 */
1801 ReplicationTime?: ReplicationTime;
1802 /**
1803 * A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified together with a ReplicationTime block.
1804 */
1805 Metrics?: Metrics;
1806 }
1807 export type DisplayName = string;
1808 export type ETag = string;
1809 export type EmailAddress = string;
1810 export type EnableRequestProgress = boolean;
1811 export type EncodingType = "url"|string;
1812 export interface Encryption {
1813 /**
1814 * The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
1815 */
1816 EncryptionType: ServerSideEncryption;
1817 /**
1818 * If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.
1819 */
1820 KMSKeyId?: SSEKMSKeyId;
1821 /**
1822 * If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.
1823 */
1824 KMSContext?: KMSContext;
1825 }
1826 export interface EncryptionConfiguration {
1827 /**
1828 * Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.
1829 */
1830 ReplicaKmsKeyID?: ReplicaKmsKeyID;
1831 }
1832 export type End = number;
1833 export interface EndEvent {
1834 }
1835 export interface Error {
1836 /**
1837 * The error key.
1838 */
1839 Key?: ObjectKey;
1840 /**
1841 * The version ID of the error.
1842 */
1843 VersionId?: ObjectVersionId;
1844 /**
1845 * The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type. Amazon S3 error codes Code: AccessDenied Description: Access Denied HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: AccountProblem Description: There is a problem with your AWS account that prevents the operation from completing successfully. Contact AWS Support for further assistance. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: AllAccessDisabled Description: All access to this Amazon S3 resource has been disabled. Contact AWS Support for further assistance. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: AmbiguousGrantByEmailAddress Description: The email address you provided is associated with more than one account. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: AuthorizationHeaderMalformed Description: The authorization header you provided is invalid. HTTP Status Code: 400 Bad Request HTTP Status Code: N/A Code: BadDigest Description: The Content-MD5 you specified did not match what we received. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: BucketAlreadyExists Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again. HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: BucketAlreadyOwnedByYou Description: The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs). Code: 409 Conflict (in all Regions except the North Virginia Region) SOAP Fault Code Prefix: Client Code: BucketNotEmpty Description: The bucket you tried to delete is not empty. HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: CredentialsNotSupported Description: This request does not support credentials. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: CrossLocationLoggingProhibited Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: EntityTooSmall Description: Your proposed upload is smaller than the minimum allowed object size. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: EntityTooLarge Description: Your proposed upload exceeds the maximum allowed object size. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: ExpiredToken Description: The provided token has expired. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: IllegalVersioningConfigurationException Description: Indicates that the versioning configuration specified in the request is invalid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: IncompleteBody Description: You did not provide the number of bytes specified by the Content-Length HTTP header HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: IncorrectNumberOfFilesInPostRequest Description: POST requires exactly one file upload per request. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InlineDataTooLarge Description: Inline data exceeds the maximum allowed size. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InternalError Description: We encountered an internal error. Please try again. HTTP Status Code: 500 Internal Server Error SOAP Fault Code Prefix: Server Code: InvalidAccessKeyId Description: The AWS access key ID you provided does not exist in our records. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: InvalidAddressingHeader Description: You must specify the Anonymous role. HTTP Status Code: N/A SOAP Fault Code Prefix: Client Code: InvalidArgument Description: Invalid Argument HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidBucketName Description: The specified bucket is not valid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidBucketState Description: The request is not valid with the current state of the bucket. HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: InvalidDigest Description: The Content-MD5 you specified is not valid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidEncryptionAlgorithmError Description: The encryption request you specified is not valid. The valid value is AES256. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidLocationConstraint Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidObjectState Description: The operation is not valid for the current state of the object. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: InvalidPart Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidPartOrder Description: The list of parts was not in ascending order. Parts list must be specified in order by part number. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidPayer Description: All access to this object has been disabled. Please contact AWS Support for further assistance. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: InvalidPolicyDocument Description: The content of the form does not meet the conditions specified in the policy document. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidRange Description: The requested range cannot be satisfied. HTTP Status Code: 416 Requested Range Not Satisfiable SOAP Fault Code Prefix: Client Code: InvalidRequest Description: Please use AWS4-HMAC-SHA256. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidRequest Description: SOAP requests must be made over an HTTPS connection. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidRequest Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidRequest Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidRequest Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidRequest Description: Amazon S3 Transfer Accelerate is not configured on this bucket. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidRequest Description: Amazon S3 Transfer Accelerate is disabled on this bucket. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidRequest Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact AWS Support for more information. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidRequest Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact AWS Support for more information. HTTP Status Code: 400 Bad Request Code: N/A Code: InvalidSecurity Description: The provided security credentials are not valid. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: InvalidSOAPRequest Description: The SOAP request body is invalid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidStorageClass Description: The storage class you specified is not valid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidTargetBucketForLogging Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidToken Description: The provided token is malformed or otherwise invalid. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: InvalidURI Description: Couldn't parse the specified URI. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: KeyTooLongError Description: Your key is too long. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MalformedACLError Description: The XML you provided was not well-formed or did not validate against our published schema. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MalformedPOSTRequest Description: The body of your POST request is not well-formed multipart/form-data. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MalformedXML Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, "The XML you provided was not well-formed or did not validate against our published schema." HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MaxMessageLengthExceeded Description: Your request was too big. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MaxPostPreDataLengthExceededError Description: Your POST request fields preceding the upload file were too large. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MetadataTooLarge Description: Your metadata headers exceed the maximum allowed metadata size. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MethodNotAllowed Description: The specified method is not allowed against this resource. HTTP Status Code: 405 Method Not Allowed SOAP Fault Code Prefix: Client Code: MissingAttachment Description: A SOAP attachment was expected, but none were found. HTTP Status Code: N/A SOAP Fault Code Prefix: Client Code: MissingContentLength Description: You must provide the Content-Length HTTP header. HTTP Status Code: 411 Length Required SOAP Fault Code Prefix: Client Code: MissingRequestBodyError Description: This happens when the user sends an empty XML document as a request. The error message is, "Request body is empty." HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MissingSecurityElement Description: The SOAP 1.1 request is missing a security element. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: MissingSecurityHeader Description: Your request is missing a required header. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: NoLoggingStatusForKey Description: There is no such thing as a logging status subresource for a key. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: NoSuchBucket Description: The specified bucket does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Code: NoSuchBucketPolicy Description: The specified bucket does not have a bucket policy. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Code: NoSuchKey Description: The specified key does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Code: NoSuchUpload Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Code: NoSuchVersion Description: Indicates that the version ID specified in the request does not match an existing version. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client Code: NotImplemented Description: A header you provided implies functionality that is not implemented. HTTP Status Code: 501 Not Implemented SOAP Fault Code Prefix: Server Code: NotSignedUp Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3 HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: OperationAborted Description: A conflicting conditional operation is currently in progress against this resource. Try again. HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: PermanentRedirect Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint. HTTP Status Code: 301 Moved Permanently SOAP Fault Code Prefix: Client Code: PreconditionFailed Description: At least one of the preconditions you specified did not hold. HTTP Status Code: 412 Precondition Failed SOAP Fault Code Prefix: Client Code: Redirect Description: Temporary redirect. HTTP Status Code: 307 Moved Temporarily SOAP Fault Code Prefix: Client Code: RestoreAlreadyInProgress Description: Object restore is already in progress. HTTP Status Code: 409 Conflict SOAP Fault Code Prefix: Client Code: RequestIsNotMultiPartContent Description: Bucket POST must be of the enclosure-type multipart/form-data. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: RequestTimeout Description: Your socket connection to the server was not read from or written to within the timeout period. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: RequestTimeTooSkewed Description: The difference between the request time and the server's time is too large. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: RequestTorrentOfBucketError Description: Requesting the torrent file of a bucket is not permitted. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: SignatureDoesNotMatch Description: The request signature we calculated does not match the signature you provided. Check your AWS secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details. HTTP Status Code: 403 Forbidden SOAP Fault Code Prefix: Client Code: ServiceUnavailable Description: Reduce your request rate. HTTP Status Code: 503 Service Unavailable SOAP Fault Code Prefix: Server Code: SlowDown Description: Reduce your request rate. HTTP Status Code: 503 Slow Down SOAP Fault Code Prefix: Server Code: TemporaryRedirect Description: You are being redirected to the bucket while DNS updates. HTTP Status Code: 307 Moved Temporarily SOAP Fault Code Prefix: Client Code: TokenRefreshRequired Description: The provided token must be refreshed. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: TooManyBuckets Description: You have attempted to create more buckets than allowed. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: UnexpectedContent Description: This request does not support content. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: UnresolvableGrantByEmailAddress Description: The email address you provided does not match any account on record. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client Code: UserKeyMustBeSpecified Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields. HTTP Status Code: 400 Bad Request SOAP Fault Code Prefix: Client
1846 */
1847 Code?: Code;
1848 /**
1849 * The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
1850 */
1851 Message?: Message;
1852 }
1853 export interface ErrorDocument {
1854 /**
1855 * The object key name to use when a 4XX class error occurs.
1856 */
1857 Key: ObjectKey;
1858 }
1859 export type Errors = Error[];
1860 export type Event = "s3:ReducedRedundancyLostObject"|"s3:ObjectCreated:*"|"s3:ObjectCreated:Put"|"s3:ObjectCreated:Post"|"s3:ObjectCreated:Copy"|"s3:ObjectCreated:CompleteMultipartUpload"|"s3:ObjectRemoved:*"|"s3:ObjectRemoved:Delete"|"s3:ObjectRemoved:DeleteMarkerCreated"|"s3:ObjectRestore:*"|"s3:ObjectRestore:Post"|"s3:ObjectRestore:Completed"|"s3:Replication:*"|"s3:Replication:OperationFailedReplication"|"s3:Replication:OperationNotTracked"|"s3:Replication:OperationMissedThreshold"|"s3:Replication:OperationReplicatedAfterThreshold"|string;
1861 export type EventList = Event[];
1862 export interface ExistingObjectReplication {
1863 /**
1864 *
1865 */
1866 Status: ExistingObjectReplicationStatus;
1867 }
1868 export type ExistingObjectReplicationStatus = "Enabled"|"Disabled"|string;
1869 export type Expiration = string;
1870 export type ExpirationStatus = "Enabled"|"Disabled"|string;
1871 export type ExpiredObjectDeleteMarker = boolean;
1872 export type Expires = Date;
1873 export type ExposeHeader = string;
1874 export type ExposeHeaders = ExposeHeader[];
1875 export type Expression = string;
1876 export type ExpressionType = "SQL"|string;
1877 export type FetchOwner = boolean;
1878 export type FieldDelimiter = string;
1879 export type FileHeaderInfo = "USE"|"IGNORE"|"NONE"|string;
1880 export interface FilterRule {
1881 /**
1882 * The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.
1883 */
1884 Name?: FilterRuleName;
1885 /**
1886 * The value that the filter searches for in object key names.
1887 */
1888 Value?: FilterRuleValue;
1889 }
1890 export type FilterRuleList = FilterRule[];
1891 export type FilterRuleName = "prefix"|"suffix"|string;
1892 export type FilterRuleValue = string;
1893 export interface GetBucketAccelerateConfigurationOutput {
1894 /**
1895 * The accelerate configuration of the bucket.
1896 */
1897 Status?: BucketAccelerateStatus;
1898 }
1899 export interface GetBucketAccelerateConfigurationRequest {
1900 /**
1901 * Name of the bucket for which the accelerate configuration is retrieved.
1902 */
1903 Bucket: BucketName;
1904 }
1905 export interface GetBucketAclOutput {
1906 /**
1907 * Container for the bucket owner's display name and ID.
1908 */
1909 Owner?: Owner;
1910 /**
1911 * A list of grants.
1912 */
1913 Grants?: Grants;
1914 }
1915 export interface GetBucketAclRequest {
1916 /**
1917 * Specifies the S3 bucket whose ACL is being requested.
1918 */
1919 Bucket: BucketName;
1920 }
1921 export interface GetBucketAnalyticsConfigurationOutput {
1922 /**
1923 * The configuration and any analyses for the analytics filter.
1924 */
1925 AnalyticsConfiguration?: AnalyticsConfiguration;
1926 }
1927 export interface GetBucketAnalyticsConfigurationRequest {
1928 /**
1929 * The name of the bucket from which an analytics configuration is retrieved.
1930 */
1931 Bucket: BucketName;
1932 /**
1933 * The ID that identifies the analytics configuration.
1934 */
1935 Id: AnalyticsId;
1936 }
1937 export interface GetBucketCorsOutput {
1938 /**
1939 * A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
1940 */
1941 CORSRules?: CORSRules;
1942 }
1943 export interface GetBucketCorsRequest {
1944 /**
1945 * The bucket name for which to get the cors configuration.
1946 */
1947 Bucket: BucketName;
1948 }
1949 export interface GetBucketEncryptionOutput {
1950 ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
1951 }
1952 export interface GetBucketEncryptionRequest {
1953 /**
1954 * The name of the bucket from which the server-side encryption configuration is retrieved.
1955 */
1956 Bucket: BucketName;
1957 }
1958 export interface GetBucketInventoryConfigurationOutput {
1959 /**
1960 * Specifies the inventory configuration.
1961 */
1962 InventoryConfiguration?: InventoryConfiguration;
1963 }
1964 export interface GetBucketInventoryConfigurationRequest {
1965 /**
1966 * The name of the bucket containing the inventory configuration to retrieve.
1967 */
1968 Bucket: BucketName;
1969 /**
1970 * The ID used to identify the inventory configuration.
1971 */
1972 Id: InventoryId;
1973 }
1974 export interface GetBucketLifecycleConfigurationOutput {
1975 /**
1976 * Container for a lifecycle rule.
1977 */
1978 Rules?: LifecycleRules;
1979 }
1980 export interface GetBucketLifecycleConfigurationRequest {
1981 /**
1982 * The name of the bucket for which to get the lifecycle information.
1983 */
1984 Bucket: BucketName;
1985 }
1986 export interface GetBucketLifecycleOutput {
1987 /**
1988 * Container for a lifecycle rule.
1989 */
1990 Rules?: Rules;
1991 }
1992 export interface GetBucketLifecycleRequest {
1993 /**
1994 * The name of the bucket for which to get the lifecycle information.
1995 */
1996 Bucket: BucketName;
1997 }
1998 export interface GetBucketLocationOutput {
1999 /**
2000 * Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints.
2001 */
2002 LocationConstraint?: BucketLocationConstraint;
2003 }
2004 export interface GetBucketLocationRequest {
2005 /**
2006 * The name of the bucket for which to get the location.
2007 */
2008 Bucket: BucketName;
2009 }
2010 export interface GetBucketLoggingOutput {
2011 LoggingEnabled?: LoggingEnabled;
2012 }
2013 export interface GetBucketLoggingRequest {
2014 /**
2015 * The bucket name for which to get the logging information.
2016 */
2017 Bucket: BucketName;
2018 }
2019 export interface GetBucketMetricsConfigurationOutput {
2020 /**
2021 * Specifies the metrics configuration.
2022 */
2023 MetricsConfiguration?: MetricsConfiguration;
2024 }
2025 export interface GetBucketMetricsConfigurationRequest {
2026 /**
2027 * The name of the bucket containing the metrics configuration to retrieve.
2028 */
2029 Bucket: BucketName;
2030 /**
2031 * The ID used to identify the metrics configuration.
2032 */
2033 Id: MetricsId;
2034 }
2035 export interface GetBucketNotificationConfigurationRequest {
2036 /**
2037 * Name of the bucket for which to get the notification configuration
2038 */
2039 Bucket: BucketName;
2040 }
2041 export interface GetBucketPolicyOutput {
2042 /**
2043 * The bucket policy as a JSON document.
2044 */
2045 Policy?: Policy;
2046 }
2047 export interface GetBucketPolicyRequest {
2048 /**
2049 * The bucket name for which to get the bucket policy.
2050 */
2051 Bucket: BucketName;
2052 }
2053 export interface GetBucketPolicyStatusOutput {
2054 /**
2055 * The policy status for the specified bucket.
2056 */
2057 PolicyStatus?: PolicyStatus;
2058 }
2059 export interface GetBucketPolicyStatusRequest {
2060 /**
2061 * The name of the Amazon S3 bucket whose policy status you want to retrieve.
2062 */
2063 Bucket: BucketName;
2064 }
2065 export interface GetBucketReplicationOutput {
2066 ReplicationConfiguration?: ReplicationConfiguration;
2067 }
2068 export interface GetBucketReplicationRequest {
2069 /**
2070 * The bucket name for which to get the replication information.
2071 */
2072 Bucket: BucketName;
2073 }
2074 export interface GetBucketRequestPaymentOutput {
2075 /**
2076 * Specifies who pays for the download and request fees.
2077 */
2078 Payer?: Payer;
2079 }
2080 export interface GetBucketRequestPaymentRequest {
2081 /**
2082 * The name of the bucket for which to get the payment request configuration
2083 */
2084 Bucket: BucketName;
2085 }
2086 export interface GetBucketTaggingOutput {
2087 /**
2088 * Contains the tag set.
2089 */
2090 TagSet: TagSet;
2091 }
2092 export interface GetBucketTaggingRequest {
2093 /**
2094 * The name of the bucket for which to get the tagging information.
2095 */
2096 Bucket: BucketName;
2097 }
2098 export interface GetBucketVersioningOutput {
2099 /**
2100 * The versioning state of the bucket.
2101 */
2102 Status?: BucketVersioningStatus;
2103 /**
2104 * Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
2105 */
2106 MFADelete?: MFADeleteStatus;
2107 }
2108 export interface GetBucketVersioningRequest {
2109 /**
2110 * The name of the bucket for which to get the versioning information.
2111 */
2112 Bucket: BucketName;
2113 }
2114 export interface GetBucketWebsiteOutput {
2115 /**
2116 * Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
2117 */
2118 RedirectAllRequestsTo?: RedirectAllRequestsTo;
2119 /**
2120 * The name of the index document for the website.
2121 */
2122 IndexDocument?: IndexDocument;
2123 /**
2124 * The name of the error document for the website.
2125 */
2126 ErrorDocument?: ErrorDocument;
2127 /**
2128 * Rules that define when a redirect is applied and the redirect behavior.
2129 */
2130 RoutingRules?: RoutingRules;
2131 }
2132 export interface GetBucketWebsiteRequest {
2133 /**
2134 * The bucket name for which to get the website configuration.
2135 */
2136 Bucket: BucketName;
2137 }
2138 export interface GetObjectAclOutput {
2139 /**
2140 * Container for the bucket owner's display name and ID.
2141 */
2142 Owner?: Owner;
2143 /**
2144 * A list of grants.
2145 */
2146 Grants?: Grants;
2147 RequestCharged?: RequestCharged;
2148 }
2149 export interface GetObjectAclRequest {
2150 /**
2151 * The bucket name that contains the object for which to get the ACL information. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
2152 */
2153 Bucket: BucketName;
2154 /**
2155 * The key of the object for which to get the ACL information.
2156 */
2157 Key: ObjectKey;
2158 /**
2159 * VersionId used to reference a specific version of the object.
2160 */
2161 VersionId?: ObjectVersionId;
2162 RequestPayer?: RequestPayer;
2163 }
2164 export interface GetObjectLegalHoldOutput {
2165 /**
2166 * The current Legal Hold status for the specified object.
2167 */
2168 LegalHold?: ObjectLockLegalHold;
2169 }
2170 export interface GetObjectLegalHoldRequest {
2171 /**
2172 * The bucket name containing the object whose Legal Hold status you want to retrieve. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
2173 */
2174 Bucket: BucketName;
2175 /**
2176 * The key name for the object whose Legal Hold status you want to retrieve.
2177 */
2178 Key: ObjectKey;
2179 /**
2180 * The version ID of the object whose Legal Hold status you want to retrieve.
2181 */
2182 VersionId?: ObjectVersionId;
2183 RequestPayer?: RequestPayer;
2184 }
2185 export interface GetObjectLockConfigurationOutput {
2186 /**
2187 * The specified bucket's Object Lock configuration.
2188 */
2189 ObjectLockConfiguration?: ObjectLockConfiguration;
2190 }
2191 export interface GetObjectLockConfigurationRequest {
2192 /**
2193 * The bucket whose Object Lock configuration you want to retrieve.
2194 */
2195 Bucket: BucketName;
2196 }
2197 export interface GetObjectOutput {
2198 /**
2199 * Object data.
2200 */
2201 Body?: Body;
2202 /**
2203 * Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
2204 */
2205 DeleteMarker?: DeleteMarker;
2206 /**
2207 * Indicates that a range of bytes was specified.
2208 */
2209 AcceptRanges?: AcceptRanges;
2210 /**
2211 * If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.
2212 */
2213 Expiration?: Expiration;
2214 /**
2215 * Provides information about object restoration operation and expiration time of the restored object copy.
2216 */
2217 Restore?: Restore;
2218 /**
2219 * Last modified date of the object
2220 */
2221 LastModified?: LastModified;
2222 /**
2223 * Size of the body in bytes.
2224 */
2225 ContentLength?: ContentLength;
2226 /**
2227 * An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
2228 */
2229 ETag?: ETag;
2230 /**
2231 * This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
2232 */
2233 MissingMeta?: MissingMeta;
2234 /**
2235 * Version of the object.
2236 */
2237 VersionId?: ObjectVersionId;
2238 /**
2239 * Specifies caching behavior along the request/reply chain.
2240 */
2241 CacheControl?: CacheControl;
2242 /**
2243 * Specifies presentational information for the object.
2244 */
2245 ContentDisposition?: ContentDisposition;
2246 /**
2247 * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
2248 */
2249 ContentEncoding?: ContentEncoding;
2250 /**
2251 * The language the content is in.
2252 */
2253 ContentLanguage?: ContentLanguage;
2254 /**
2255 * The portion of the object returned in the response.
2256 */
2257 ContentRange?: ContentRange;
2258 /**
2259 * A standard MIME type describing the format of the object data.
2260 */
2261 ContentType?: ContentType;
2262 /**
2263 * The date and time at which the object is no longer cacheable.
2264 */
2265 Expires?: Expires;
2266 /**
2267 * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
2268 */
2269 WebsiteRedirectLocation?: WebsiteRedirectLocation;
2270 /**
2271 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
2272 */
2273 ServerSideEncryption?: ServerSideEncryption;
2274 /**
2275 * A map of metadata to store with the object in S3.
2276 */
2277 Metadata?: Metadata;
2278 /**
2279 * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
2280 */
2281 SSECustomerAlgorithm?: SSECustomerAlgorithm;
2282 /**
2283 * 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.
2284 */
2285 SSECustomerKeyMD5?: SSECustomerKeyMD5;
2286 /**
2287 * 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.
2288 */
2289 SSEKMSKeyId?: SSEKMSKeyId;
2290 /**
2291 * Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.
2292 */
2293 StorageClass?: StorageClass;
2294 RequestCharged?: RequestCharged;
2295 /**
2296 * Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
2297 */
2298 ReplicationStatus?: ReplicationStatus;
2299 /**
2300 * The count of parts this object has.
2301 */
2302 PartsCount?: PartsCount;
2303 /**
2304 * The number of tags, if any, on the object.
2305 */
2306 TagCount?: TagCount;
2307 /**
2308 * The Object Lock mode currently in place for this object.
2309 */
2310 ObjectLockMode?: ObjectLockMode;
2311 /**
2312 * The date and time when this object's Object Lock will expire.
2313 */
2314 ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
2315 /**
2316 * Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
2317 */
2318 ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
2319 }
2320 export interface GetObjectRequest {
2321 /**
2322 * The bucket name containing the object. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
2323 */
2324 Bucket: BucketName;
2325 /**
2326 * Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
2327 */
2328 IfMatch?: IfMatch;
2329 /**
2330 * Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
2331 */
2332 IfModifiedSince?: IfModifiedSince;
2333 /**
2334 * Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
2335 */
2336 IfNoneMatch?: IfNoneMatch;
2337 /**
2338 * Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
2339 */
2340 IfUnmodifiedSince?: IfUnmodifiedSince;
2341 /**
2342 * Key of the object to get.
2343 */
2344 Key: ObjectKey;
2345 /**
2346 * Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
2347 */
2348 Range?: Range;
2349 /**
2350 * Sets the Cache-Control header of the response.
2351 */
2352 ResponseCacheControl?: ResponseCacheControl;
2353 /**
2354 * Sets the Content-Disposition header of the response
2355 */
2356 ResponseContentDisposition?: ResponseContentDisposition;
2357 /**
2358 * Sets the Content-Encoding header of the response.
2359 */
2360 ResponseContentEncoding?: ResponseContentEncoding;
2361 /**
2362 * Sets the Content-Language header of the response.
2363 */
2364 ResponseContentLanguage?: ResponseContentLanguage;
2365 /**
2366 * Sets the Content-Type header of the response.
2367 */
2368 ResponseContentType?: ResponseContentType;
2369 /**
2370 * Sets the Expires header of the response.
2371 */
2372 ResponseExpires?: ResponseExpires;
2373 /**
2374 * VersionId used to reference a specific version of the object.
2375 */
2376 VersionId?: ObjectVersionId;
2377 /**
2378 * Specifies the algorithm to use to when encrypting the object (for example, AES256).
2379 */
2380 SSECustomerAlgorithm?: SSECustomerAlgorithm;
2381 /**
2382 * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
2383 */
2384 SSECustomerKey?: SSECustomerKey;
2385 /**
2386 * 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.
2387 */
2388 SSECustomerKeyMD5?: SSECustomerKeyMD5;
2389 RequestPayer?: RequestPayer;
2390 /**
2391 * Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
2392 */
2393 PartNumber?: PartNumber;
2394 }
2395 export interface GetObjectRetentionOutput {
2396 /**
2397 * The container element for an object's retention settings.
2398 */
2399 Retention?: ObjectLockRetention;
2400 }
2401 export interface GetObjectRetentionRequest {
2402 /**
2403 * The bucket name containing the object whose retention settings you want to retrieve. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
2404 */
2405 Bucket: BucketName;
2406 /**
2407 * The key name for the object whose retention settings you want to retrieve.
2408 */
2409 Key: ObjectKey;
2410 /**
2411 * The version ID for the object whose retention settings you want to retrieve.
2412 */
2413 VersionId?: ObjectVersionId;
2414 RequestPayer?: RequestPayer;
2415 }
2416 export interface GetObjectTaggingOutput {
2417 /**
2418 * The versionId of the object for which you got the tagging information.
2419 */
2420 VersionId?: ObjectVersionId;
2421 /**
2422 * Contains the tag set.
2423 */
2424 TagSet: TagSet;
2425 }
2426 export interface GetObjectTaggingRequest {
2427 /**
2428 * The bucket name containing the object for which to get the tagging information. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
2429 */
2430 Bucket: BucketName;
2431 /**
2432 * Object key for which to get the tagging information.
2433 */
2434 Key: ObjectKey;
2435 /**
2436 * The versionId of the object for which to get the tagging information.
2437 */
2438 VersionId?: ObjectVersionId;
2439 }
2440 export interface GetObjectTorrentOutput {
2441 /**
2442 * A Bencoded dictionary as defined by the BitTorrent specification
2443 */
2444 Body?: Body;
2445 RequestCharged?: RequestCharged;
2446 }
2447 export interface GetObjectTorrentRequest {
2448 /**
2449 * The name of the bucket containing the object for which to get the torrent files.
2450 */
2451 Bucket: BucketName;
2452 /**
2453 * The object key for which to get the information.
2454 */
2455 Key: ObjectKey;
2456 RequestPayer?: RequestPayer;
2457 }
2458 export interface GetPublicAccessBlockOutput {
2459 /**
2460 * The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.
2461 */
2462 PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
2463 }
2464 export interface GetPublicAccessBlockRequest {
2465 /**
2466 * The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.
2467 */
2468 Bucket: BucketName;
2469 }
2470 export interface GlacierJobParameters {
2471 /**
2472 * Glacier retrieval tier at which the restore will be processed.
2473 */
2474 Tier: Tier;
2475 }
2476 export interface Grant {
2477 /**
2478 * The person being granted permissions.
2479 */
2480 Grantee?: Grantee;
2481 /**
2482 * Specifies the permission given to the grantee.
2483 */
2484 Permission?: Permission;
2485 }
2486 export type GrantFullControl = string;
2487 export type GrantRead = string;
2488 export type GrantReadACP = string;
2489 export type GrantWrite = string;
2490 export type GrantWriteACP = string;
2491 export interface Grantee {
2492 /**
2493 * Screen name of the grantee.
2494 */
2495 DisplayName?: DisplayName;
2496 /**
2497 * Email address of the grantee.
2498 */
2499 EmailAddress?: EmailAddress;
2500 /**
2501 * The canonical user ID of the grantee.
2502 */
2503 ID?: ID;
2504 /**
2505 * Type of grantee
2506 */
2507 Type: Type;
2508 /**
2509 * URI of the grantee group.
2510 */
2511 URI?: URI;
2512 }
2513 export type Grants = Grant[];
2514 export interface HeadBucketRequest {
2515 /**
2516 * The bucket name.
2517 */
2518 Bucket: BucketName;
2519 }
2520 export interface HeadObjectOutput {
2521 /**
2522 * Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
2523 */
2524 DeleteMarker?: DeleteMarker;
2525 /**
2526 * Indicates that a range of bytes was specified.
2527 */
2528 AcceptRanges?: AcceptRanges;
2529 /**
2530 * If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.
2531 */
2532 Expiration?: Expiration;
2533 /**
2534 * If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored. If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example: x-amz-restore: ongoing-request="false", expiry-date="Fri, 23 Dec 2012 00:00:00 GMT" If the object restoration is in progress, the header returns the value ongoing-request="true". For more information about archiving objects, see Transitioning Objects: General Considerations.
2535 */
2536 Restore?: Restore;
2537 /**
2538 * Last modified date of the object
2539 */
2540 LastModified?: LastModified;
2541 /**
2542 * Size of the body in bytes.
2543 */
2544 ContentLength?: ContentLength;
2545 /**
2546 * An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
2547 */
2548 ETag?: ETag;
2549 /**
2550 * This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
2551 */
2552 MissingMeta?: MissingMeta;
2553 /**
2554 * Version of the object.
2555 */
2556 VersionId?: ObjectVersionId;
2557 /**
2558 * Specifies caching behavior along the request/reply chain.
2559 */
2560 CacheControl?: CacheControl;
2561 /**
2562 * Specifies presentational information for the object.
2563 */
2564 ContentDisposition?: ContentDisposition;
2565 /**
2566 * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
2567 */
2568 ContentEncoding?: ContentEncoding;
2569 /**
2570 * The language the content is in.
2571 */
2572 ContentLanguage?: ContentLanguage;
2573 /**
2574 * A standard MIME type describing the format of the object data.
2575 */
2576 ContentType?: ContentType;
2577 /**
2578 * The date and time at which the object is no longer cacheable.
2579 */
2580 Expires?: Expires;
2581 /**
2582 * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
2583 */
2584 WebsiteRedirectLocation?: WebsiteRedirectLocation;
2585 /**
2586 * If the object is stored using server-side encryption either with an AWS KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
2587 */
2588 ServerSideEncryption?: ServerSideEncryption;
2589 /**
2590 * A map of metadata to store with the object in S3.
2591 */
2592 Metadata?: Metadata;
2593 /**
2594 * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
2595 */
2596 SSECustomerAlgorithm?: SSECustomerAlgorithm;
2597 /**
2598 * 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.
2599 */
2600 SSECustomerKeyMD5?: SSECustomerKeyMD5;
2601 /**
2602 * 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.
2603 */
2604 SSEKMSKeyId?: SSEKMSKeyId;
2605 /**
2606 * Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects. For more information, see Storage Classes.
2607 */
2608 StorageClass?: StorageClass;
2609 RequestCharged?: RequestCharged;
2610 /**
2611 * Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule. In replication, you have a source bucket on which you configure replication and destination bucket where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows: If requesting an object from the source bucket — Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication. For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status. If requesting an object from the destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created. For more information, see Replication.
2612 */
2613 ReplicationStatus?: ReplicationStatus;
2614 /**
2615 * The count of parts this object has.
2616 */
2617 PartsCount?: PartsCount;
2618 /**
2619 * The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.
2620 */
2621 ObjectLockMode?: ObjectLockMode;
2622 /**
2623 * The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.
2624 */
2625 ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
2626 /**
2627 * Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
2628 */
2629 ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
2630 }
2631 export interface HeadObjectRequest {
2632 /**
2633 * The name of the bucket containing the object.
2634 */
2635 Bucket: BucketName;
2636 /**
2637 * Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
2638 */
2639 IfMatch?: IfMatch;
2640 /**
2641 * Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
2642 */
2643 IfModifiedSince?: IfModifiedSince;
2644 /**
2645 * Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
2646 */
2647 IfNoneMatch?: IfNoneMatch;
2648 /**
2649 * Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
2650 */
2651 IfUnmodifiedSince?: IfUnmodifiedSince;
2652 /**
2653 * The object key.
2654 */
2655 Key: ObjectKey;
2656 /**
2657 * Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
2658 */
2659 Range?: Range;
2660 /**
2661 * VersionId used to reference a specific version of the object.
2662 */
2663 VersionId?: ObjectVersionId;
2664 /**
2665 * Specifies the algorithm to use to when encrypting the object (for example, AES256).
2666 */
2667 SSECustomerAlgorithm?: SSECustomerAlgorithm;
2668 /**
2669 * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
2670 */
2671 SSECustomerKey?: SSECustomerKey;
2672 /**
2673 * 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.
2674 */
2675 SSECustomerKeyMD5?: SSECustomerKeyMD5;
2676 RequestPayer?: RequestPayer;
2677 /**
2678 * Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
2679 */
2680 PartNumber?: PartNumber;
2681 }
2682 export type HostName = string;
2683 export type HttpErrorCodeReturnedEquals = string;
2684 export type HttpRedirectCode = string;
2685 export type ID = string;
2686 export type IfMatch = string;
2687 export type IfModifiedSince = Date;
2688 export type IfNoneMatch = string;
2689 export type IfUnmodifiedSince = Date;
2690 export interface IndexDocument {
2691 /**
2692 * A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
2693 */
2694 Suffix: Suffix;
2695 }
2696 export type Initiated = Date;
2697 export interface Initiator {
2698 /**
2699 * If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.
2700 */
2701 ID?: ID;
2702 /**
2703 * Name of the Principal.
2704 */
2705 DisplayName?: DisplayName;
2706 }
2707 export interface InputSerialization {
2708 /**
2709 * Describes the serialization of a CSV-encoded object.
2710 */
2711 CSV?: CSVInput;
2712 /**
2713 * Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.
2714 */
2715 CompressionType?: CompressionType;
2716 /**
2717 * Specifies JSON as object's input serialization format.
2718 */
2719 JSON?: JSONInput;
2720 /**
2721 * Specifies Parquet as object's input serialization format.
2722 */
2723 Parquet?: ParquetInput;
2724 }
2725 export interface InventoryConfiguration {
2726 /**
2727 * Contains information about where to publish the inventory results.
2728 */
2729 Destination: InventoryDestination;
2730 /**
2731 * Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.
2732 */
2733 IsEnabled: IsEnabled;
2734 /**
2735 * Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
2736 */
2737 Filter?: InventoryFilter;
2738 /**
2739 * The ID used to identify the inventory configuration.
2740 */
2741 Id: InventoryId;
2742 /**
2743 * Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.
2744 */
2745 IncludedObjectVersions: InventoryIncludedObjectVersions;
2746 /**
2747 * Contains the optional fields that are included in the inventory results.
2748 */
2749 OptionalFields?: InventoryOptionalFields;
2750 /**
2751 * Specifies the schedule for generating inventory results.
2752 */
2753 Schedule: InventorySchedule;
2754 }
2755 export type InventoryConfigurationList = InventoryConfiguration[];
2756 export interface InventoryDestination {
2757 /**
2758 * Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
2759 */
2760 S3BucketDestination: InventoryS3BucketDestination;
2761 }
2762 export interface InventoryEncryption {
2763 /**
2764 * Specifies the use of SSE-S3 to encrypt delivered inventory reports.
2765 */
2766 SSES3?: SSES3;
2767 /**
2768 * Specifies the use of SSE-KMS to encrypt delivered inventory reports.
2769 */
2770 SSEKMS?: SSEKMS;
2771 }
2772 export interface InventoryFilter {
2773 /**
2774 * The prefix that an object must have to be included in the inventory results.
2775 */
2776 Prefix: Prefix;
2777 }
2778 export type InventoryFormat = "CSV"|"ORC"|"Parquet"|string;
2779 export type InventoryFrequency = "Daily"|"Weekly"|string;
2780 export type InventoryId = string;
2781 export type InventoryIncludedObjectVersions = "All"|"Current"|string;
2782 export type InventoryOptionalField = "Size"|"LastModifiedDate"|"StorageClass"|"ETag"|"IsMultipartUploaded"|"ReplicationStatus"|"EncryptionStatus"|"ObjectLockRetainUntilDate"|"ObjectLockMode"|"ObjectLockLegalHoldStatus"|"IntelligentTieringAccessTier"|string;
2783 export type InventoryOptionalFields = InventoryOptionalField[];
2784 export interface InventoryS3BucketDestination {
2785 /**
2786 * The ID of the account that owns the destination bucket.
2787 */
2788 AccountId?: AccountId;
2789 /**
2790 * The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
2791 */
2792 Bucket: BucketName;
2793 /**
2794 * Specifies the output format of the inventory results.
2795 */
2796 Format: InventoryFormat;
2797 /**
2798 * The prefix that is prepended to all inventory results.
2799 */
2800 Prefix?: Prefix;
2801 /**
2802 * Contains the type of server-side encryption used to encrypt the inventory results.
2803 */
2804 Encryption?: InventoryEncryption;
2805 }
2806 export interface InventorySchedule {
2807 /**
2808 * Specifies how frequently inventory results are produced.
2809 */
2810 Frequency: InventoryFrequency;
2811 }
2812 export type IsEnabled = boolean;
2813 export type IsLatest = boolean;
2814 export type IsPublic = boolean;
2815 export type IsTruncated = boolean;
2816 export interface JSONInput {
2817 /**
2818 * The type of JSON. Valid values: Document, Lines.
2819 */
2820 Type?: JSONType;
2821 }
2822 export interface JSONOutput {
2823 /**
2824 * The value used to separate individual records in the output.
2825 */
2826 RecordDelimiter?: RecordDelimiter;
2827 }
2828 export type JSONType = "DOCUMENT"|"LINES"|string;
2829 export type KMSContext = string;
2830 export type KeyCount = number;
2831 export type KeyMarker = string;
2832 export type KeyPrefixEquals = string;
2833 export type LambdaFunctionArn = string;
2834 export interface LambdaFunctionConfiguration {
2835 Id?: NotificationId;
2836 /**
2837 * The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.
2838 */
2839 LambdaFunctionArn: LambdaFunctionArn;
2840 /**
2841 * The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide.
2842 */
2843 Events: EventList;
2844 Filter?: NotificationConfigurationFilter;
2845 }
2846 export type LambdaFunctionConfigurationList = LambdaFunctionConfiguration[];
2847 export type LastModified = Date;
2848 export interface LifecycleConfiguration {
2849 /**
2850 * Specifies lifecycle configuration rules for an Amazon S3 bucket.
2851 */
2852 Rules: Rules;
2853 }
2854 export interface LifecycleExpiration {
2855 /**
2856 * Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
2857 */
2858 Date?: _Date;
2859 /**
2860 * Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
2861 */
2862 Days?: Days;
2863 /**
2864 * Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
2865 */
2866 ExpiredObjectDeleteMarker?: ExpiredObjectDeleteMarker;
2867 }
2868 export interface LifecycleRule {
2869 /**
2870 * Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
2871 */
2872 Expiration?: LifecycleExpiration;
2873 /**
2874 * Unique identifier for the rule. The value cannot be longer than 255 characters.
2875 */
2876 ID?: ID;
2877 /**
2878 * Prefix identifying one or more objects to which the rule applies. This is No longer used; use Filter instead.
2879 */
2880 Prefix?: Prefix;
2881 Filter?: LifecycleRuleFilter;
2882 /**
2883 * If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
2884 */
2885 Status: ExpirationStatus;
2886 /**
2887 * Specifies when an Amazon S3 object transitions to a specified storage class.
2888 */
2889 Transitions?: TransitionList;
2890 /**
2891 * Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
2892 */
2893 NoncurrentVersionTransitions?: NoncurrentVersionTransitionList;
2894 NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
2895 AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
2896 }
2897 export interface LifecycleRuleAndOperator {
2898 /**
2899 * Prefix identifying one or more objects to which the rule applies.
2900 */
2901 Prefix?: Prefix;
2902 /**
2903 * All of these tags must exist in the object's tag set in order for the rule to apply.
2904 */
2905 Tags?: TagSet;
2906 }
2907 export interface LifecycleRuleFilter {
2908 /**
2909 * Prefix identifying one or more objects to which the rule applies.
2910 */
2911 Prefix?: Prefix;
2912 /**
2913 * This tag must exist in the object's tag set in order for the rule to apply.
2914 */
2915 Tag?: Tag;
2916 And?: LifecycleRuleAndOperator;
2917 }
2918 export type LifecycleRules = LifecycleRule[];
2919 export interface ListBucketAnalyticsConfigurationsOutput {
2920 /**
2921 * Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
2922 */
2923 IsTruncated?: IsTruncated;
2924 /**
2925 * The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.
2926 */
2927 ContinuationToken?: Token;
2928 /**
2929 * NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.
2930 */
2931 NextContinuationToken?: NextToken;
2932 /**
2933 * The list of analytics configurations for a bucket.
2934 */
2935 AnalyticsConfigurationList?: AnalyticsConfigurationList;
2936 }
2937 export interface ListBucketAnalyticsConfigurationsRequest {
2938 /**
2939 * The name of the bucket from which analytics configurations are retrieved.
2940 */
2941 Bucket: BucketName;
2942 /**
2943 * The ContinuationToken that represents a placeholder from where this request should begin.
2944 */
2945 ContinuationToken?: Token;
2946 }
2947 export interface ListBucketInventoryConfigurationsOutput {
2948 /**
2949 * If sent in the request, the marker that is used as a starting point for this inventory configuration list response.
2950 */
2951 ContinuationToken?: Token;
2952 /**
2953 * The list of inventory configurations for a bucket.
2954 */
2955 InventoryConfigurationList?: InventoryConfigurationList;
2956 /**
2957 * Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.
2958 */
2959 IsTruncated?: IsTruncated;
2960 /**
2961 * The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
2962 */
2963 NextContinuationToken?: NextToken;
2964 }
2965 export interface ListBucketInventoryConfigurationsRequest {
2966 /**
2967 * The name of the bucket containing the inventory configurations to retrieve.
2968 */
2969 Bucket: BucketName;
2970 /**
2971 * The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
2972 */
2973 ContinuationToken?: Token;
2974 }
2975 export interface ListBucketMetricsConfigurationsOutput {
2976 /**
2977 * Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
2978 */
2979 IsTruncated?: IsTruncated;
2980 /**
2981 * The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.
2982 */
2983 ContinuationToken?: Token;
2984 /**
2985 * The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
2986 */
2987 NextContinuationToken?: NextToken;
2988 /**
2989 * The list of metrics configurations for a bucket.
2990 */
2991 MetricsConfigurationList?: MetricsConfigurationList;
2992 }
2993 export interface ListBucketMetricsConfigurationsRequest {
2994 /**
2995 * The name of the bucket containing the metrics configurations to retrieve.
2996 */
2997 Bucket: BucketName;
2998 /**
2999 * The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
3000 */
3001 ContinuationToken?: Token;
3002 }
3003 export interface ListBucketsOutput {
3004 /**
3005 * The list of buckets owned by the requestor.
3006 */
3007 Buckets?: Buckets;
3008 /**
3009 * The owner of the buckets listed.
3010 */
3011 Owner?: Owner;
3012 }
3013 export interface ListMultipartUploadsOutput {
3014 /**
3015 * Name of the bucket to which the multipart upload was initiated.
3016 */
3017 Bucket?: BucketName;
3018 /**
3019 * The key at or after which the listing began.
3020 */
3021 KeyMarker?: KeyMarker;
3022 /**
3023 * Upload ID after which listing began.
3024 */
3025 UploadIdMarker?: UploadIdMarker;
3026 /**
3027 * When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
3028 */
3029 NextKeyMarker?: NextKeyMarker;
3030 /**
3031 * When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
3032 */
3033 Prefix?: Prefix;
3034 /**
3035 * Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.
3036 */
3037 Delimiter?: Delimiter;
3038 /**
3039 * When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
3040 */
3041 NextUploadIdMarker?: NextUploadIdMarker;
3042 /**
3043 * Maximum number of multipart uploads that could have been included in the response.
3044 */
3045 MaxUploads?: MaxUploads;
3046 /**
3047 * Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
3048 */
3049 IsTruncated?: IsTruncated;
3050 /**
3051 * Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.
3052 */
3053 Uploads?: MultipartUploadList;
3054 /**
3055 * If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.
3056 */
3057 CommonPrefixes?: CommonPrefixList;
3058 /**
3059 * Encoding type used by Amazon S3 to encode object keys in the response. If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements: Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.
3060 */
3061 EncodingType?: EncodingType;
3062 }
3063 export interface ListMultipartUploadsRequest {
3064 /**
3065 * 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
3066 */
3067 Bucket: BucketName;
3068 /**
3069 * Character you use to group keys. All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.
3070 */
3071 Delimiter?: Delimiter;
3072 EncodingType?: EncodingType;
3073 /**
3074 * Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list. If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.
3075 */
3076 KeyMarker?: KeyMarker;
3077 /**
3078 * Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
3079 */
3080 MaxUploads?: MaxUploads;
3081 /**
3082 * Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)
3083 */
3084 Prefix?: Prefix;
3085 /**
3086 * Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.
3087 */
3088 UploadIdMarker?: UploadIdMarker;
3089 }
3090 export interface ListObjectVersionsOutput {
3091 /**
3092 * A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
3093 */
3094 IsTruncated?: IsTruncated;
3095 /**
3096 * Marks the last key returned in a truncated response.
3097 */
3098 KeyMarker?: KeyMarker;
3099 /**
3100 * Marks the last version of the key returned in a truncated response.
3101 */
3102 VersionIdMarker?: VersionIdMarker;
3103 /**
3104 * When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.
3105 */
3106 NextKeyMarker?: NextKeyMarker;
3107 /**
3108 * When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.
3109 */
3110 NextVersionIdMarker?: NextVersionIdMarker;
3111 /**
3112 * Container for version information.
3113 */
3114 Versions?: ObjectVersionList;
3115 /**
3116 * Container for an object that is a delete marker.
3117 */
3118 DeleteMarkers?: DeleteMarkers;
3119 /**
3120 * Bucket name.
3121 */
3122 Name?: BucketName;
3123 /**
3124 * Selects objects that start with the value supplied by this parameter.
3125 */
3126 Prefix?: Prefix;
3127 /**
3128 * The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
3129 */
3130 Delimiter?: Delimiter;
3131 /**
3132 * Specifies the maximum number of objects to return.
3133 */
3134 MaxKeys?: MaxKeys;
3135 /**
3136 * All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
3137 */
3138 CommonPrefixes?: CommonPrefixList;
3139 /**
3140 * Encoding type used by Amazon S3 to encode object key names in the XML response. If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements: KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.
3141 */
3142 EncodingType?: EncodingType;
3143 }
3144 export interface ListObjectVersionsRequest {
3145 /**
3146 * The bucket name that contains the objects. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
3147 */
3148 Bucket: BucketName;
3149 /**
3150 * A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
3151 */
3152 Delimiter?: Delimiter;
3153 EncodingType?: EncodingType;
3154 /**
3155 * Specifies the key to start with when listing objects in a bucket.
3156 */
3157 KeyMarker?: KeyMarker;
3158 /**
3159 * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains &lt;isTruncated&gt;true&lt;/isTruncated&gt;. To return the additional keys, see key-marker and version-id-marker.
3160 */
3161 MaxKeys?: MaxKeys;
3162 /**
3163 * Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
3164 */
3165 Prefix?: Prefix;
3166 /**
3167 * Specifies the object version you want to start listing from.
3168 */
3169 VersionIdMarker?: VersionIdMarker;
3170 }
3171 export interface ListObjectsOutput {
3172 /**
3173 * A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
3174 */
3175 IsTruncated?: IsTruncated;
3176 /**
3177 * Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
3178 */
3179 Marker?: Marker;
3180 /**
3181 * When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
3182 */
3183 NextMarker?: NextMarker;
3184 /**
3185 * Metadata about each object returned.
3186 */
3187 Contents?: ObjectList;
3188 /**
3189 * Bucket name.
3190 */
3191 Name?: BucketName;
3192 /**
3193 * Keys that begin with the indicated prefix.
3194 */
3195 Prefix?: Prefix;
3196 /**
3197 * Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
3198 */
3199 Delimiter?: Delimiter;
3200 /**
3201 * The maximum number of keys returned in the response body.
3202 */
3203 MaxKeys?: MaxKeys;
3204 /**
3205 * All of the keys rolled up in a common prefix count as a single return when calculating the number of returns. A response can contain CommonPrefixes only if you specify a delimiter. CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
3206 */
3207 CommonPrefixes?: CommonPrefixList;
3208 /**
3209 * Encoding type used by Amazon S3 to encode object keys in the response.
3210 */
3211 EncodingType?: EncodingType;
3212 }
3213 export interface ListObjectsRequest {
3214 /**
3215 * The name of the bucket containing the objects.
3216 */
3217 Bucket: BucketName;
3218 /**
3219 * A delimiter is a character you use to group keys.
3220 */
3221 Delimiter?: Delimiter;
3222 EncodingType?: EncodingType;
3223 /**
3224 * Specifies the key to start with when listing objects in a bucket.
3225 */
3226 Marker?: Marker;
3227 /**
3228 * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
3229 */
3230 MaxKeys?: MaxKeys;
3231 /**
3232 * Limits the response to keys that begin with the specified prefix.
3233 */
3234 Prefix?: Prefix;
3235 /**
3236 * Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
3237 */
3238 RequestPayer?: RequestPayer;
3239 }
3240 export interface ListObjectsV2Output {
3241 /**
3242 * Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.
3243 */
3244 IsTruncated?: IsTruncated;
3245 /**
3246 * Metadata about each object returned.
3247 */
3248 Contents?: ObjectList;
3249 /**
3250 * 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
3251 */
3252 Name?: BucketName;
3253 /**
3254 * Keys that begin with the indicated prefix.
3255 */
3256 Prefix?: Prefix;
3257 /**
3258 * Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
3259 */
3260 Delimiter?: Delimiter;
3261 /**
3262 * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
3263 */
3264 MaxKeys?: MaxKeys;
3265 /**
3266 * All of the keys rolled up into a common prefix count as a single return when calculating the number of returns. A response can contain CommonPrefixes only if you specify a delimiter. CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
3267 */
3268 CommonPrefixes?: CommonPrefixList;
3269 /**
3270 * Encoding type used by Amazon S3 to encode object key names in the XML response. If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements: Delimiter, Prefix, Key, and StartAfter.
3271 */
3272 EncodingType?: EncodingType;
3273 /**
3274 * KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
3275 */
3276 KeyCount?: KeyCount;
3277 /**
3278 * If ContinuationToken was sent with the request, it is included in the response.
3279 */
3280 ContinuationToken?: Token;
3281 /**
3282 * NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
3283 */
3284 NextContinuationToken?: NextToken;
3285 /**
3286 * If StartAfter was sent with the request, it is included in the response.
3287 */
3288 StartAfter?: StartAfter;
3289 }
3290 export interface ListObjectsV2Request {
3291 /**
3292 * Bucket name to list. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
3293 */
3294 Bucket: BucketName;
3295 /**
3296 * A delimiter is a character you use to group keys.
3297 */
3298 Delimiter?: Delimiter;
3299 /**
3300 * Encoding type used by Amazon S3 to encode object keys in the response.
3301 */
3302 EncodingType?: EncodingType;
3303 /**
3304 * Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
3305 */
3306 MaxKeys?: MaxKeys;
3307 /**
3308 * Limits the response to keys that begin with the specified prefix.
3309 */
3310 Prefix?: Prefix;
3311 /**
3312 * ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.
3313 */
3314 ContinuationToken?: Token;
3315 /**
3316 * The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.
3317 */
3318 FetchOwner?: FetchOwner;
3319 /**
3320 * StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
3321 */
3322 StartAfter?: StartAfter;
3323 /**
3324 * Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
3325 */
3326 RequestPayer?: RequestPayer;
3327 }
3328 export interface ListPartsOutput {
3329 /**
3330 * If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy. The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.
3331 */
3332 AbortDate?: AbortDate;
3333 /**
3334 * This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
3335 */
3336 AbortRuleId?: AbortRuleId;
3337 /**
3338 * Name of the bucket to which the multipart upload was initiated.
3339 */
3340 Bucket?: BucketName;
3341 /**
3342 * Object key for which the multipart upload was initiated.
3343 */
3344 Key?: ObjectKey;
3345 /**
3346 * Upload ID identifying the multipart upload whose parts are being listed.
3347 */
3348 UploadId?: MultipartUploadId;
3349 /**
3350 * When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
3351 */
3352 PartNumberMarker?: PartNumberMarker;
3353 /**
3354 * When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
3355 */
3356 NextPartNumberMarker?: NextPartNumberMarker;
3357 /**
3358 * Maximum number of parts that were allowed in the response.
3359 */
3360 MaxParts?: MaxParts;
3361 /**
3362 * Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
3363 */
3364 IsTruncated?: IsTruncated;
3365 /**
3366 * Container for elements related to a particular part. A response can contain zero or more Part elements.
3367 */
3368 Parts?: Parts;
3369 /**
3370 * Container element that identifies who initiated the multipart upload. If the initiator is an AWS account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.
3371 */
3372 Initiator?: Initiator;
3373 /**
3374 * Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
3375 */
3376 Owner?: Owner;
3377 /**
3378 * Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
3379 */
3380 StorageClass?: StorageClass;
3381 RequestCharged?: RequestCharged;
3382 }
3383 export interface ListPartsRequest {
3384 /**
3385 * Name of the bucket to which the parts are being uploaded. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
3386 */
3387 Bucket: BucketName;
3388 /**
3389 * Object key for which the multipart upload was initiated.
3390 */
3391 Key: ObjectKey;
3392 /**
3393 * Sets the maximum number of parts to return.
3394 */
3395 MaxParts?: MaxParts;
3396 /**
3397 * Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
3398 */
3399 PartNumberMarker?: PartNumberMarker;
3400 /**
3401 * Upload ID identifying the multipart upload whose parts are being listed.
3402 */
3403 UploadId: MultipartUploadId;
3404 RequestPayer?: RequestPayer;
3405 }
3406 export type Location = string;
3407 export type LocationPrefix = string;
3408 export interface LoggingEnabled {
3409 /**
3410 * Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
3411 */
3412 TargetBucket: TargetBucket;
3413 /**
3414 * Container for granting information.
3415 */
3416 TargetGrants?: TargetGrants;
3417 /**
3418 * A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.
3419 */
3420 TargetPrefix: TargetPrefix;
3421 }
3422 export type MFA = string;
3423 export type MFADelete = "Enabled"|"Disabled"|string;
3424 export type MFADeleteStatus = "Enabled"|"Disabled"|string;
3425 export type Marker = string;
3426 export type MaxAgeSeconds = number;
3427 export type MaxKeys = number;
3428 export type MaxParts = number;
3429 export type MaxUploads = number;
3430 export type Message = string;
3431 export type Metadata = {[key: string]: MetadataValue};
3432 export type MetadataDirective = "COPY"|"REPLACE"|string;
3433 export interface MetadataEntry {
3434 /**
3435 * Name of the Object.
3436 */
3437 Name?: MetadataKey;
3438 /**
3439 * Value of the Object.
3440 */
3441 Value?: MetadataValue;
3442 }
3443 export type MetadataKey = string;
3444 export type MetadataValue = string;
3445 export interface Metrics {
3446 /**
3447 * Specifies whether the replication metrics are enabled.
3448 */
3449 Status: MetricsStatus;
3450 /**
3451 * A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.
3452 */
3453 EventThreshold: ReplicationTimeValue;
3454 }
3455 export interface MetricsAndOperator {
3456 /**
3457 * The prefix used when evaluating an AND predicate.
3458 */
3459 Prefix?: Prefix;
3460 /**
3461 * The list of tags used when evaluating an AND predicate.
3462 */
3463 Tags?: TagSet;
3464 }
3465 export interface MetricsConfiguration {
3466 /**
3467 * The ID used to identify the metrics configuration.
3468 */
3469 Id: MetricsId;
3470 /**
3471 * Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).
3472 */
3473 Filter?: MetricsFilter;
3474 }
3475 export type MetricsConfigurationList = MetricsConfiguration[];
3476 export interface MetricsFilter {
3477 /**
3478 * The prefix used when evaluating a metrics filter.
3479 */
3480 Prefix?: Prefix;
3481 /**
3482 * The tag used when evaluating a metrics filter.
3483 */
3484 Tag?: Tag;
3485 /**
3486 * A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
3487 */
3488 And?: MetricsAndOperator;
3489 }
3490 export type MetricsId = string;
3491 export type MetricsStatus = "Enabled"|"Disabled"|string;
3492 export type Minutes = number;
3493 export type MissingMeta = number;
3494 export interface MultipartUpload {
3495 /**
3496 * Upload ID that identifies the multipart upload.
3497 */
3498 UploadId?: MultipartUploadId;
3499 /**
3500 * Key of the object for which the multipart upload was initiated.
3501 */
3502 Key?: ObjectKey;
3503 /**
3504 * Date and time at which the multipart upload was initiated.
3505 */
3506 Initiated?: Initiated;
3507 /**
3508 * The class of storage used to store the object.
3509 */
3510 StorageClass?: StorageClass;
3511 /**
3512 * Specifies the owner of the object that is part of the multipart upload.
3513 */
3514 Owner?: Owner;
3515 /**
3516 * Identifies who initiated the multipart upload.
3517 */
3518 Initiator?: Initiator;
3519 }
3520 export type MultipartUploadId = string;
3521 export type MultipartUploadList = MultipartUpload[];
3522 export type NextKeyMarker = string;
3523 export type NextMarker = string;
3524 export type NextPartNumberMarker = number;
3525 export type NextToken = string;
3526 export type NextUploadIdMarker = string;
3527 export type NextVersionIdMarker = string;
3528 export interface NoncurrentVersionExpiration {
3529 /**
3530 * Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
3531 */
3532 NoncurrentDays?: Days;
3533 }
3534 export interface NoncurrentVersionTransition {
3535 /**
3536 * Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide.
3537 */
3538 NoncurrentDays?: Days;
3539 /**
3540 * The class of storage used to store the object.
3541 */
3542 StorageClass?: TransitionStorageClass;
3543 }
3544 export type NoncurrentVersionTransitionList = NoncurrentVersionTransition[];
3545 export interface NotificationConfiguration {
3546 /**
3547 * The topic to which notifications are sent and the events for which notifications are generated.
3548 */
3549 TopicConfigurations?: TopicConfigurationList;
3550 /**
3551 * The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
3552 */
3553 QueueConfigurations?: QueueConfigurationList;
3554 /**
3555 * Describes the AWS Lambda functions to invoke and the events for which to invoke them.
3556 */
3557 LambdaFunctionConfigurations?: LambdaFunctionConfigurationList;
3558 }
3559 export interface NotificationConfigurationDeprecated {
3560 /**
3561 * This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
3562 */
3563 TopicConfiguration?: TopicConfigurationDeprecated;
3564 /**
3565 * This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
3566 */
3567 QueueConfiguration?: QueueConfigurationDeprecated;
3568 /**
3569 * Container for specifying the AWS Lambda notification configuration.
3570 */
3571 CloudFunctionConfiguration?: CloudFunctionConfiguration;
3572 }
3573 export interface NotificationConfigurationFilter {
3574 Key?: S3KeyFilter;
3575 }
3576 export type NotificationId = string;
3577 export interface Object {
3578 /**
3579 * The name that you assign to an object. You use the object key to retrieve the object.
3580 */
3581 Key?: ObjectKey;
3582 /**
3583 * The date the Object was Last Modified
3584 */
3585 LastModified?: LastModified;
3586 /**
3587 * The entity tag is an MD5 hash of the object. ETag reflects only changes to the contents of an object, not its metadata.
3588 */
3589 ETag?: ETag;
3590 /**
3591 * Size in bytes of the object
3592 */
3593 Size?: Size;
3594 /**
3595 * The class of storage used to store the object.
3596 */
3597 StorageClass?: ObjectStorageClass;
3598 /**
3599 * The owner of the object
3600 */
3601 Owner?: Owner;
3602 }
3603 export type ObjectCannedACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"aws-exec-read"|"bucket-owner-read"|"bucket-owner-full-control"|string;
3604 export interface ObjectIdentifier {
3605 /**
3606 * Key name of the object to delete.
3607 */
3608 Key: ObjectKey;
3609 /**
3610 * VersionId for the specific version of the object to delete.
3611 */
3612 VersionId?: ObjectVersionId;
3613 }
3614 export type ObjectIdentifierList = ObjectIdentifier[];
3615 export type ObjectKey = string;
3616 export type ObjectList = Object[];
3617 export interface ObjectLockConfiguration {
3618 /**
3619 * Indicates whether this bucket has an Object Lock configuration enabled.
3620 */
3621 ObjectLockEnabled?: ObjectLockEnabled;
3622 /**
3623 * The Object Lock rule in place for the specified object.
3624 */
3625 Rule?: ObjectLockRule;
3626 }
3627 export type ObjectLockEnabled = "Enabled"|string;
3628 export type ObjectLockEnabledForBucket = boolean;
3629 export interface ObjectLockLegalHold {
3630 /**
3631 * Indicates whether the specified object has a Legal Hold in place.
3632 */
3633 Status?: ObjectLockLegalHoldStatus;
3634 }
3635 export type ObjectLockLegalHoldStatus = "ON"|"OFF"|string;
3636 export type ObjectLockMode = "GOVERNANCE"|"COMPLIANCE"|string;
3637 export type ObjectLockRetainUntilDate = Date;
3638 export interface ObjectLockRetention {
3639 /**
3640 * Indicates the Retention mode for the specified object.
3641 */
3642 Mode?: ObjectLockRetentionMode;
3643 /**
3644 * The date on which this Object Lock Retention will expire.
3645 */
3646 RetainUntilDate?: _Date;
3647 }
3648 export type ObjectLockRetentionMode = "GOVERNANCE"|"COMPLIANCE"|string;
3649 export interface ObjectLockRule {
3650 /**
3651 * The default retention period that you want to apply to new objects placed in the specified bucket.
3652 */
3653 DefaultRetention?: DefaultRetention;
3654 }
3655 export type ObjectLockToken = string;
3656 export type ObjectStorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string;
3657 export interface ObjectVersion {
3658 /**
3659 * The entity tag is an MD5 hash of that version of the object.
3660 */
3661 ETag?: ETag;
3662 /**
3663 * Size in bytes of the object.
3664 */
3665 Size?: Size;
3666 /**
3667 * The class of storage used to store the object.
3668 */
3669 StorageClass?: ObjectVersionStorageClass;
3670 /**
3671 * The object key.
3672 */
3673 Key?: ObjectKey;
3674 /**
3675 * Version ID of an object.
3676 */
3677 VersionId?: ObjectVersionId;
3678 /**
3679 * Specifies whether the object is (true) or is not (false) the latest version of an object.
3680 */
3681 IsLatest?: IsLatest;
3682 /**
3683 * Date and time the object was last modified.
3684 */
3685 LastModified?: LastModified;
3686 /**
3687 * Specifies the owner of the object.
3688 */
3689 Owner?: Owner;
3690 }
3691 export type ObjectVersionId = string;
3692 export type ObjectVersionList = ObjectVersion[];
3693 export type ObjectVersionStorageClass = "STANDARD"|string;
3694 export interface OutputLocation {
3695 /**
3696 * Describes an S3 location that will receive the results of the restore request.
3697 */
3698 S3?: S3Location;
3699 }
3700 export interface OutputSerialization {
3701 /**
3702 * Describes the serialization of CSV-encoded Select results.
3703 */
3704 CSV?: CSVOutput;
3705 /**
3706 * Specifies JSON as request's output serialization format.
3707 */
3708 JSON?: JSONOutput;
3709 }
3710 export interface Owner {
3711 /**
3712 * Container for the display name of the owner.
3713 */
3714 DisplayName?: DisplayName;
3715 /**
3716 * Container for the ID of the owner.
3717 */
3718 ID?: ID;
3719 }
3720 export type OwnerOverride = "Destination"|string;
3721 export interface ParquetInput {
3722 }
3723 export interface Part {
3724 /**
3725 * Part number identifying the part. This is a positive integer between 1 and 10,000.
3726 */
3727 PartNumber?: PartNumber;
3728 /**
3729 * Date and time at which the part was uploaded.
3730 */
3731 LastModified?: LastModified;
3732 /**
3733 * Entity tag returned when the part was uploaded.
3734 */
3735 ETag?: ETag;
3736 /**
3737 * Size in bytes of the uploaded part data.
3738 */
3739 Size?: Size;
3740 }
3741 export type PartNumber = number;
3742 export type PartNumberMarker = number;
3743 export type Parts = Part[];
3744 export type PartsCount = number;
3745 export type Payer = "Requester"|"BucketOwner"|string;
3746 export type Permission = "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"|string;
3747 export type Policy = string;
3748 export interface PolicyStatus {
3749 /**
3750 * The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.
3751 */
3752 IsPublic?: IsPublic;
3753 }
3754 export type Prefix = string;
3755 export type Priority = number;
3756 export interface Progress {
3757 /**
3758 * The current number of object bytes scanned.
3759 */
3760 BytesScanned?: BytesScanned;
3761 /**
3762 * The current number of uncompressed object bytes processed.
3763 */
3764 BytesProcessed?: BytesProcessed;
3765 /**
3766 * The current number of bytes of records payload data returned.
3767 */
3768 BytesReturned?: BytesReturned;
3769 }
3770 export interface ProgressEvent {
3771 /**
3772 * The Progress event details.
3773 */
3774 Details?: Progress;
3775 }
3776 export type Protocol = "http"|"https"|string;
3777 export interface PublicAccessBlockConfiguration {
3778 /**
3779 * Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. PUT Object calls fail if the request includes a public ACL. PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
3780 */
3781 BlockPublicAcls?: Setting;
3782 /**
3783 * Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
3784 */
3785 IgnorePublicAcls?: Setting;
3786 /**
3787 * Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.
3788 */
3789 BlockPublicPolicy?: Setting;
3790 /**
3791 * Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
3792 */
3793 RestrictPublicBuckets?: Setting;
3794 }
3795 export interface PutBucketAccelerateConfigurationRequest {
3796 /**
3797 * Name of the bucket for which the accelerate configuration is set.
3798 */
3799 Bucket: BucketName;
3800 /**
3801 * Container for setting the transfer acceleration state.
3802 */
3803 AccelerateConfiguration: AccelerateConfiguration;
3804 }
3805 export interface PutBucketAclRequest {
3806 /**
3807 * The canned ACL to apply to the bucket.
3808 */
3809 ACL?: BucketCannedACL;
3810 /**
3811 * Contains the elements that set the ACL permissions for an object per grantee.
3812 */
3813 AccessControlPolicy?: AccessControlPolicy;
3814 /**
3815 * The bucket to which to apply the ACL.
3816 */
3817 Bucket: BucketName;
3818 /**
3819 * The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
3820 */
3821 ContentMD5?: ContentMD5;
3822 /**
3823 * Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
3824 */
3825 GrantFullControl?: GrantFullControl;
3826 /**
3827 * Allows grantee to list the objects in the bucket.
3828 */
3829 GrantRead?: GrantRead;
3830 /**
3831 * Allows grantee to read the bucket ACL.
3832 */
3833 GrantReadACP?: GrantReadACP;
3834 /**
3835 * Allows grantee to create, overwrite, and delete any object in the bucket.
3836 */
3837 GrantWrite?: GrantWrite;
3838 /**
3839 * Allows grantee to write the ACL for the applicable bucket.
3840 */
3841 GrantWriteACP?: GrantWriteACP;
3842 }
3843 export interface PutBucketAnalyticsConfigurationRequest {
3844 /**
3845 * The name of the bucket to which an analytics configuration is stored.
3846 */
3847 Bucket: BucketName;
3848 /**
3849 * The ID that identifies the analytics configuration.
3850 */
3851 Id: AnalyticsId;
3852 /**
3853 * The configuration and any analyses for the analytics filter.
3854 */
3855 AnalyticsConfiguration: AnalyticsConfiguration;
3856 }
3857 export interface PutBucketCorsRequest {
3858 /**
3859 * Specifies the bucket impacted by the corsconfiguration.
3860 */
3861 Bucket: BucketName;
3862 /**
3863 * Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
3864 */
3865 CORSConfiguration: CORSConfiguration;
3866 /**
3867 * The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
3868 */
3869 ContentMD5?: ContentMD5;
3870 }
3871 export interface PutBucketEncryptionRequest {
3872 /**
3873 * Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.
3874 */
3875 Bucket: BucketName;
3876 /**
3877 * The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. This parameter is auto-populated when using the command from the CLI.
3878 */
3879 ContentMD5?: ContentMD5;
3880 ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration;
3881 }
3882 export interface PutBucketInventoryConfigurationRequest {
3883 /**
3884 * The name of the bucket where the inventory configuration will be stored.
3885 */
3886 Bucket: BucketName;
3887 /**
3888 * The ID used to identify the inventory configuration.
3889 */
3890 Id: InventoryId;
3891 /**
3892 * Specifies the inventory configuration.
3893 */
3894 InventoryConfiguration: InventoryConfiguration;
3895 }
3896 export interface PutBucketLifecycleConfigurationRequest {
3897 /**
3898 * The name of the bucket for which to set the configuration.
3899 */
3900 Bucket: BucketName;
3901 /**
3902 * Container for lifecycle rules. You can add as many as 1,000 rules.
3903 */
3904 LifecycleConfiguration?: BucketLifecycleConfiguration;
3905 }
3906 export interface PutBucketLifecycleRequest {
3907 /**
3908 *
3909 */
3910 Bucket: BucketName;
3911 /**
3912 *
3913 */
3914 ContentMD5?: ContentMD5;
3915 /**
3916 *
3917 */
3918 LifecycleConfiguration?: LifecycleConfiguration;
3919 }
3920 export interface PutBucketLoggingRequest {
3921 /**
3922 * The name of the bucket for which to set the logging parameters.
3923 */
3924 Bucket: BucketName;
3925 /**
3926 * Container for logging status information.
3927 */
3928 BucketLoggingStatus: BucketLoggingStatus;
3929 /**
3930 * The MD5 hash of the PutBucketLogging request body.
3931 */
3932 ContentMD5?: ContentMD5;
3933 }
3934 export interface PutBucketMetricsConfigurationRequest {
3935 /**
3936 * The name of the bucket for which the metrics configuration is set.
3937 */
3938 Bucket: BucketName;
3939 /**
3940 * The ID used to identify the metrics configuration.
3941 */
3942 Id: MetricsId;
3943 /**
3944 * Specifies the metrics configuration.
3945 */
3946 MetricsConfiguration: MetricsConfiguration;
3947 }
3948 export interface PutBucketNotificationConfigurationRequest {
3949 /**
3950 * The name of the bucket.
3951 */
3952 Bucket: BucketName;
3953 NotificationConfiguration: NotificationConfiguration;
3954 }
3955 export interface PutBucketNotificationRequest {
3956 /**
3957 * The name of the bucket.
3958 */
3959 Bucket: BucketName;
3960 /**
3961 * The MD5 hash of the PutPublicAccessBlock request body.
3962 */
3963 ContentMD5?: ContentMD5;
3964 /**
3965 * The container for the configuration.
3966 */
3967 NotificationConfiguration: NotificationConfigurationDeprecated;
3968 }
3969 export interface PutBucketPolicyRequest {
3970 /**
3971 * The name of the bucket.
3972 */
3973 Bucket: BucketName;
3974 /**
3975 * The MD5 hash of the request body.
3976 */
3977 ContentMD5?: ContentMD5;
3978 /**
3979 * Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
3980 */
3981 ConfirmRemoveSelfBucketAccess?: ConfirmRemoveSelfBucketAccess;
3982 /**
3983 * The bucket policy as a JSON document.
3984 */
3985 Policy: Policy;
3986 }
3987 export interface PutBucketReplicationRequest {
3988 /**
3989 * The name of the bucket
3990 */
3991 Bucket: BucketName;
3992 /**
3993 * The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
3994 */
3995 ContentMD5?: ContentMD5;
3996 ReplicationConfiguration: ReplicationConfiguration;
3997 /**
3998 *
3999 */
4000 Token?: ObjectLockToken;
4001 }
4002 export interface PutBucketRequestPaymentRequest {
4003 /**
4004 * The bucket name.
4005 */
4006 Bucket: BucketName;
4007 /**
4008 * &gt;The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
4009 */
4010 ContentMD5?: ContentMD5;
4011 /**
4012 * Container for Payer.
4013 */
4014 RequestPaymentConfiguration: RequestPaymentConfiguration;
4015 }
4016 export interface PutBucketTaggingRequest {
4017 /**
4018 * The bucket name.
4019 */
4020 Bucket: BucketName;
4021 /**
4022 * The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
4023 */
4024 ContentMD5?: ContentMD5;
4025 /**
4026 * Container for the TagSet and Tag elements.
4027 */
4028 Tagging: Tagging;
4029 }
4030 export interface PutBucketVersioningRequest {
4031 /**
4032 * The bucket name.
4033 */
4034 Bucket: BucketName;
4035 /**
4036 * &gt;The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
4037 */
4038 ContentMD5?: ContentMD5;
4039 /**
4040 * The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
4041 */
4042 MFA?: MFA;
4043 /**
4044 * Container for setting the versioning state.
4045 */
4046 VersioningConfiguration: VersioningConfiguration;
4047 }
4048 export interface PutBucketWebsiteRequest {
4049 /**
4050 * The bucket name.
4051 */
4052 Bucket: BucketName;
4053 /**
4054 * The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
4055 */
4056 ContentMD5?: ContentMD5;
4057 /**
4058 * Container for the request.
4059 */
4060 WebsiteConfiguration: WebsiteConfiguration;
4061 }
4062 export interface PutObjectAclOutput {
4063 RequestCharged?: RequestCharged;
4064 }
4065 export interface PutObjectAclRequest {
4066 /**
4067 * The canned ACL to apply to the object. For more information, see Canned ACL.
4068 */
4069 ACL?: ObjectCannedACL;
4070 /**
4071 * Contains the elements that set the ACL permissions for an object per grantee.
4072 */
4073 AccessControlPolicy?: AccessControlPolicy;
4074 /**
4075 * The bucket name that contains the object to which you want to attach the ACL. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
4076 */
4077 Bucket: BucketName;
4078 /**
4079 * The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.&gt;
4080 */
4081 ContentMD5?: ContentMD5;
4082 /**
4083 * Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
4084 */
4085 GrantFullControl?: GrantFullControl;
4086 /**
4087 * Allows grantee to list the objects in the bucket.
4088 */
4089 GrantRead?: GrantRead;
4090 /**
4091 * Allows grantee to read the bucket ACL.
4092 */
4093 GrantReadACP?: GrantReadACP;
4094 /**
4095 * Allows grantee to create, overwrite, and delete any object in the bucket.
4096 */
4097 GrantWrite?: GrantWrite;
4098 /**
4099 * Allows grantee to write the ACL for the applicable bucket.
4100 */
4101 GrantWriteACP?: GrantWriteACP;
4102 /**
4103 * Key for which the PUT operation was initiated.
4104 */
4105 Key: ObjectKey;
4106 RequestPayer?: RequestPayer;
4107 /**
4108 * VersionId used to reference a specific version of the object.
4109 */
4110 VersionId?: ObjectVersionId;
4111 }
4112 export interface PutObjectLegalHoldOutput {
4113 RequestCharged?: RequestCharged;
4114 }
4115 export interface PutObjectLegalHoldRequest {
4116 /**
4117 * The bucket name containing the object that you want to place a Legal Hold on. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
4118 */
4119 Bucket: BucketName;
4120 /**
4121 * The key name for the object that you want to place a Legal Hold on.
4122 */
4123 Key: ObjectKey;
4124 /**
4125 * Container element for the Legal Hold configuration you want to apply to the specified object.
4126 */
4127 LegalHold?: ObjectLockLegalHold;
4128 RequestPayer?: RequestPayer;
4129 /**
4130 * The version ID of the object that you want to place a Legal Hold on.
4131 */
4132 VersionId?: ObjectVersionId;
4133 /**
4134 * The MD5 hash for the request body.
4135 */
4136 ContentMD5?: ContentMD5;
4137 }
4138 export interface PutObjectLockConfigurationOutput {
4139 RequestCharged?: RequestCharged;
4140 }
4141 export interface PutObjectLockConfigurationRequest {
4142 /**
4143 * The bucket whose Object Lock configuration you want to create or replace.
4144 */
4145 Bucket: BucketName;
4146 /**
4147 * The Object Lock configuration that you want to apply to the specified bucket.
4148 */
4149 ObjectLockConfiguration?: ObjectLockConfiguration;
4150 RequestPayer?: RequestPayer;
4151 /**
4152 * A token to allow Object Lock to be enabled for an existing bucket.
4153 */
4154 Token?: ObjectLockToken;
4155 /**
4156 * The MD5 hash for the request body.
4157 */
4158 ContentMD5?: ContentMD5;
4159 }
4160 export interface PutObjectOutput {
4161 /**
4162 * If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.
4163 */
4164 Expiration?: Expiration;
4165 /**
4166 * Entity tag for the uploaded object.
4167 */
4168 ETag?: ETag;
4169 /**
4170 * If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
4171 */
4172 ServerSideEncryption?: ServerSideEncryption;
4173 /**
4174 * Version of the object.
4175 */
4176 VersionId?: ObjectVersionId;
4177 /**
4178 * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
4179 */
4180 SSECustomerAlgorithm?: SSECustomerAlgorithm;
4181 /**
4182 * 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.
4183 */
4184 SSECustomerKeyMD5?: SSECustomerKeyMD5;
4185 /**
4186 * If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.
4187 */
4188 SSEKMSKeyId?: SSEKMSKeyId;
4189 /**
4190 * If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
4191 */
4192 SSEKMSEncryptionContext?: SSEKMSEncryptionContext;
4193 RequestCharged?: RequestCharged;
4194 }
4195 export interface PutObjectRequest {
4196 /**
4197 * The canned ACL to apply to the object. For more information, see Canned ACL.
4198 */
4199 ACL?: ObjectCannedACL;
4200 /**
4201 * Object data.
4202 */
4203 Body?: Body;
4204 /**
4205 * Bucket name to which the PUT operation 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
4206 */
4207 Bucket: BucketName;
4208 /**
4209 * Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
4210 */
4211 CacheControl?: CacheControl;
4212 /**
4213 * Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
4214 */
4215 ContentDisposition?: ContentDisposition;
4216 /**
4217 * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
4218 */
4219 ContentEncoding?: ContentEncoding;
4220 /**
4221 * The language the content is in.
4222 */
4223 ContentLanguage?: ContentLanguage;
4224 /**
4225 * Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
4226 */
4227 ContentLength?: ContentLength;
4228 /**
4229 * The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
4230 */
4231 ContentMD5?: ContentMD5;
4232 /**
4233 * A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
4234 */
4235 ContentType?: ContentType;
4236 /**
4237 * The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
4238 */
4239 Expires?: Expires;
4240 /**
4241 * Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
4242 */
4243 GrantFullControl?: GrantFullControl;
4244 /**
4245 * Allows grantee to read the object data and its metadata.
4246 */
4247 GrantRead?: GrantRead;
4248 /**
4249 * Allows grantee to read the object ACL.
4250 */
4251 GrantReadACP?: GrantReadACP;
4252 /**
4253 * Allows grantee to write the ACL for the applicable object.
4254 */
4255 GrantWriteACP?: GrantWriteACP;
4256 /**
4257 * Object key for which the PUT operation was initiated.
4258 */
4259 Key: ObjectKey;
4260 /**
4261 * A map of metadata to store with the object in S3.
4262 */
4263 Metadata?: Metadata;
4264 /**
4265 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
4266 */
4267 ServerSideEncryption?: ServerSideEncryption;
4268 /**
4269 * If you don't specify, Standard is the default storage class. Amazon S3 supports other storage classes.
4270 */
4271 StorageClass?: StorageClass;
4272 /**
4273 * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata. In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket: x-amz-website-redirect-location: /anotherPage.html In the following example, the request header sets the object redirect to another website: x-amz-website-redirect-location: http://www.example.com/ For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
4274 */
4275 WebsiteRedirectLocation?: WebsiteRedirectLocation;
4276 /**
4277 * Specifies the algorithm to use to when encrypting the object (for example, AES256).
4278 */
4279 SSECustomerAlgorithm?: SSECustomerAlgorithm;
4280 /**
4281 * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
4282 */
4283 SSECustomerKey?: SSECustomerKey;
4284 /**
4285 * 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.
4286 */
4287 SSECustomerKeyMD5?: SSECustomerKeyMD5;
4288 /**
4289 * If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object. If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.
4290 */
4291 SSEKMSKeyId?: SSEKMSKeyId;
4292 /**
4293 * Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
4294 */
4295 SSEKMSEncryptionContext?: SSEKMSEncryptionContext;
4296 RequestPayer?: RequestPayer;
4297 /**
4298 * The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
4299 */
4300 Tagging?: TaggingHeader;
4301 /**
4302 * The Object Lock mode that you want to apply to this object.
4303 */
4304 ObjectLockMode?: ObjectLockMode;
4305 /**
4306 * The date and time when you want this object's Object Lock to expire.
4307 */
4308 ObjectLockRetainUntilDate?: ObjectLockRetainUntilDate;
4309 /**
4310 * Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
4311 */
4312 ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
4313 }
4314 export interface PutObjectRetentionOutput {
4315 RequestCharged?: RequestCharged;
4316 }
4317 export interface PutObjectRetentionRequest {
4318 /**
4319 * The bucket name that contains the object you want to apply this Object Retention configuration to. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
4320 */
4321 Bucket: BucketName;
4322 /**
4323 * The key name for the object that you want to apply this Object Retention configuration to.
4324 */
4325 Key: ObjectKey;
4326 /**
4327 * The container element for the Object Retention configuration.
4328 */
4329 Retention?: ObjectLockRetention;
4330 RequestPayer?: RequestPayer;
4331 /**
4332 * The version ID for the object that you want to apply this Object Retention configuration to.
4333 */
4334 VersionId?: ObjectVersionId;
4335 /**
4336 * Indicates whether this operation should bypass Governance-mode restrictions.
4337 */
4338 BypassGovernanceRetention?: BypassGovernanceRetention;
4339 /**
4340 * The MD5 hash for the request body.
4341 */
4342 ContentMD5?: ContentMD5;
4343 }
4344 export interface PutObjectTaggingOutput {
4345 /**
4346 * The versionId of the object the tag-set was added to.
4347 */
4348 VersionId?: ObjectVersionId;
4349 }
4350 export interface PutObjectTaggingRequest {
4351 /**
4352 * The bucket name containing the object. 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
4353 */
4354 Bucket: BucketName;
4355 /**
4356 * Name of the tag.
4357 */
4358 Key: ObjectKey;
4359 /**
4360 * The versionId of the object that the tag-set will be added to.
4361 */
4362 VersionId?: ObjectVersionId;
4363 /**
4364 * The MD5 hash for the request body.
4365 */
4366 ContentMD5?: ContentMD5;
4367 /**
4368 * Container for the TagSet and Tag elements
4369 */
4370 Tagging: Tagging;
4371 }
4372 export interface PutPublicAccessBlockRequest {
4373 /**
4374 * The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.
4375 */
4376 Bucket: BucketName;
4377 /**
4378 * The MD5 hash of the PutPublicAccessBlock request body.
4379 */
4380 ContentMD5?: ContentMD5;
4381 /**
4382 * The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.
4383 */
4384 PublicAccessBlockConfiguration: PublicAccessBlockConfiguration;
4385 }
4386 export type QueueArn = string;
4387 export interface QueueConfiguration {
4388 Id?: NotificationId;
4389 /**
4390 * The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.
4391 */
4392 QueueArn: QueueArn;
4393 /**
4394 * A collection of bucket events for which to send notifications
4395 */
4396 Events: EventList;
4397 Filter?: NotificationConfigurationFilter;
4398 }
4399 export interface QueueConfigurationDeprecated {
4400 Id?: NotificationId;
4401 Event?: Event;
4402 /**
4403 * A collection of bucket events for which to send notifications
4404 */
4405 Events?: EventList;
4406 /**
4407 * The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.
4408 */
4409 Queue?: QueueArn;
4410 }
4411 export type QueueConfigurationList = QueueConfiguration[];
4412 export type Quiet = boolean;
4413 export type QuoteCharacter = string;
4414 export type QuoteEscapeCharacter = string;
4415 export type QuoteFields = "ALWAYS"|"ASNEEDED"|string;
4416 export type Range = string;
4417 export type RecordDelimiter = string;
4418 export interface RecordsEvent {
4419 /**
4420 * The byte array of partial, one or more result records.
4421 */
4422 Payload?: Buffer;
4423 }
4424 export interface Redirect {
4425 /**
4426 * The host name to use in the redirect request.
4427 */
4428 HostName?: HostName;
4429 /**
4430 * The HTTP redirect code to use on the response. Not required if one of the siblings is present.
4431 */
4432 HttpRedirectCode?: HttpRedirectCode;
4433 /**
4434 * Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
4435 */
4436 Protocol?: Protocol;
4437 /**
4438 * The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
4439 */
4440 ReplaceKeyPrefixWith?: ReplaceKeyPrefixWith;
4441 /**
4442 * The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.
4443 */
4444 ReplaceKeyWith?: ReplaceKeyWith;
4445 }
4446 export interface RedirectAllRequestsTo {
4447 /**
4448 * Name of the host where requests are redirected.
4449 */
4450 HostName: HostName;
4451 /**
4452 * Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
4453 */
4454 Protocol?: Protocol;
4455 }
4456 export type ReplaceKeyPrefixWith = string;
4457 export type ReplaceKeyWith = string;
4458 export type ReplicaKmsKeyID = string;
4459 export interface ReplicationConfiguration {
4460 /**
4461 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication in the Amazon Simple Storage Service Developer Guide.
4462 */
4463 Role: Role;
4464 /**
4465 * A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.
4466 */
4467 Rules: ReplicationRules;
4468 }
4469 export interface ReplicationRule {
4470 /**
4471 * A unique identifier for the rule. The maximum value is 255 characters.
4472 */
4473 ID?: ID;
4474 /**
4475 * The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example: Same object quality prefix-based filter criteria if prefixes you specified in multiple rules overlap Same object qualify tag-based filter criteria specified in multiple rules For more information, see Replication in the Amazon Simple Storage Service Developer Guide.
4476 */
4477 Priority?: Priority;
4478 /**
4479 * An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.
4480 */
4481 Prefix?: Prefix;
4482 Filter?: ReplicationRuleFilter;
4483 /**
4484 * Specifies whether the rule is enabled.
4485 */
4486 Status: ReplicationRuleStatus;
4487 /**
4488 * A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service (SSE-KMS).
4489 */
4490 SourceSelectionCriteria?: SourceSelectionCriteria;
4491 /**
4492 *
4493 */
4494 ExistingObjectReplication?: ExistingObjectReplication;
4495 /**
4496 * A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
4497 */
4498 Destination: Destination;
4499 DeleteMarkerReplication?: DeleteMarkerReplication;
4500 }
4501 export interface ReplicationRuleAndOperator {
4502 /**
4503 * An object key name prefix that identifies the subset of objects to which the rule applies.
4504 */
4505 Prefix?: Prefix;
4506 /**
4507 * An array of tags containing key and value pairs.
4508 */
4509 Tags?: TagSet;
4510 }
4511 export interface ReplicationRuleFilter {
4512 /**
4513 * An object key name prefix that identifies the subset of objects to which the rule applies.
4514 */
4515 Prefix?: Prefix;
4516 /**
4517 * A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set.
4518 */
4519 Tag?: Tag;
4520 /**
4521 * A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: If you specify both a Prefix and a Tag filter, wrap these filters in an And tag. If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.
4522 */
4523 And?: ReplicationRuleAndOperator;
4524 }
4525 export type ReplicationRuleStatus = "Enabled"|"Disabled"|string;
4526 export type ReplicationRules = ReplicationRule[];
4527 export type ReplicationStatus = "COMPLETE"|"PENDING"|"FAILED"|"REPLICA"|string;
4528 export interface ReplicationTime {
4529 /**
4530 * Specifies whether the replication time is enabled.
4531 */
4532 Status: ReplicationTimeStatus;
4533 /**
4534 * A container specifying the time by which replication should be complete for all objects and operations on objects.
4535 */
4536 Time: ReplicationTimeValue;
4537 }
4538 export type ReplicationTimeStatus = "Enabled"|"Disabled"|string;
4539 export interface ReplicationTimeValue {
4540 /**
4541 * Contains an integer specifying time in minutes. Valid values: 15 minutes.
4542 */
4543 Minutes?: Minutes;
4544 }
4545 export type RequestCharged = "requester"|string;
4546 export type RequestPayer = "requester"|string;
4547 export interface RequestPaymentConfiguration {
4548 /**
4549 * Specifies who pays for the download and request fees.
4550 */
4551 Payer: Payer;
4552 }
4553 export interface RequestProgress {
4554 /**
4555 * Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.
4556 */
4557 Enabled?: EnableRequestProgress;
4558 }
4559 export type ResponseCacheControl = string;
4560 export type ResponseContentDisposition = string;
4561 export type ResponseContentEncoding = string;
4562 export type ResponseContentLanguage = string;
4563 export type ResponseContentType = string;
4564 export type ResponseExpires = Date;
4565 export type Restore = string;
4566 export interface RestoreObjectOutput {
4567 RequestCharged?: RequestCharged;
4568 /**
4569 * Indicates the path in the provided S3 output location where Select results will be restored to.
4570 */
4571 RestoreOutputPath?: RestoreOutputPath;
4572 }
4573 export interface RestoreObjectRequest {
4574 /**
4575 * The bucket name or 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 using 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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
4576 */
4577 Bucket: BucketName;
4578 /**
4579 * Object key for which the operation was initiated.
4580 */
4581 Key: ObjectKey;
4582 /**
4583 * VersionId used to reference a specific version of the object.
4584 */
4585 VersionId?: ObjectVersionId;
4586 RestoreRequest?: RestoreRequest;
4587 RequestPayer?: RequestPayer;
4588 }
4589 export type RestoreOutputPath = string;
4590 export interface RestoreRequest {
4591 /**
4592 * Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.
4593 */
4594 Days?: Days;
4595 /**
4596 * Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.
4597 */
4598 GlacierJobParameters?: GlacierJobParameters;
4599 /**
4600 * Type of restore request.
4601 */
4602 Type?: RestoreRequestType;
4603 /**
4604 * Glacier retrieval tier at which the restore will be processed.
4605 */
4606 Tier?: Tier;
4607 /**
4608 * The optional description for the job.
4609 */
4610 Description?: Description;
4611 /**
4612 * Describes the parameters for Select job types.
4613 */
4614 SelectParameters?: SelectParameters;
4615 /**
4616 * Describes the location where the restore job's output is stored.
4617 */
4618 OutputLocation?: OutputLocation;
4619 }
4620 export type RestoreRequestType = "SELECT"|string;
4621 export type Role = string;
4622 export interface RoutingRule {
4623 /**
4624 * A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
4625 */
4626 Condition?: Condition;
4627 /**
4628 * Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.
4629 */
4630 Redirect: Redirect;
4631 }
4632 export type RoutingRules = RoutingRule[];
4633 export interface Rule {
4634 /**
4635 * Specifies the expiration for the lifecycle of the object.
4636 */
4637 Expiration?: LifecycleExpiration;
4638 /**
4639 * Unique identifier for the rule. The value can't be longer than 255 characters.
4640 */
4641 ID?: ID;
4642 /**
4643 * Object key prefix that identifies one or more objects to which this rule applies.
4644 */
4645 Prefix: Prefix;
4646 /**
4647 * If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.
4648 */
4649 Status: ExpirationStatus;
4650 /**
4651 * Specifies when an object transitions to a specified storage class.
4652 */
4653 Transition?: Transition;
4654 NoncurrentVersionTransition?: NoncurrentVersionTransition;
4655 NoncurrentVersionExpiration?: NoncurrentVersionExpiration;
4656 AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
4657 }
4658 export type Rules = Rule[];
4659 export interface S3KeyFilter {
4660 FilterRules?: FilterRuleList;
4661 }
4662 export interface S3Location {
4663 /**
4664 * The name of the bucket where the restore results will be placed.
4665 */
4666 BucketName: BucketName;
4667 /**
4668 * The prefix that is prepended to the restore results for this request.
4669 */
4670 Prefix: LocationPrefix;
4671 Encryption?: Encryption;
4672 /**
4673 * The canned ACL to apply to the restore results.
4674 */
4675 CannedACL?: ObjectCannedACL;
4676 /**
4677 * A list of grants that control access to the staged results.
4678 */
4679 AccessControlList?: Grants;
4680 /**
4681 * The tag-set that is applied to the restore results.
4682 */
4683 Tagging?: Tagging;
4684 /**
4685 * A list of metadata to store with the restore results in S3.
4686 */
4687 UserMetadata?: UserMetadata;
4688 /**
4689 * The class of storage used to store the restore results.
4690 */
4691 StorageClass?: StorageClass;
4692 }
4693 export type SSECustomerAlgorithm = string;
4694 export type SSECustomerKey = Buffer|Uint8Array|Blob|string;
4695 export type SSECustomerKeyMD5 = string;
4696 export interface SSEKMS {
4697 /**
4698 * Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) to use for encrypting inventory reports.
4699 */
4700 KeyId: SSEKMSKeyId;
4701 }
4702 export type SSEKMSEncryptionContext = string;
4703 export type SSEKMSKeyId = string;
4704 export interface SSES3 {
4705 }
4706 export interface ScanRange {
4707 /**
4708 * 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; &lt;scanrange&gt;&lt;start&gt;50&lt;/start&gt;&lt;/scanrange&gt; means scan from byte 50 until the end of the file.
4709 */
4710 Start?: Start;
4711 /**
4712 * 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, &lt;scanrange&gt;&lt;end&gt;50&lt;/end&gt;&lt;/scanrange&gt; means scan the last 50 bytes.
4713 */
4714 End?: End;
4715 }
4716 export type SelectObjectContentEventStream = EventStream<{Records?:RecordsEvent,Stats?:StatsEvent,Progress?:ProgressEvent,Cont?:ContinuationEvent,End?:EndEvent}>;
4717 export interface SelectObjectContentOutput {
4718 /**
4719 * The array of results.
4720 */
4721 Payload?: SelectObjectContentEventStream;
4722 }
4723 export interface SelectObjectContentRequest {
4724 /**
4725 * The S3 bucket.
4726 */
4727 Bucket: BucketName;
4728 /**
4729 * The object key.
4730 */
4731 Key: ObjectKey;
4732 /**
4733 * The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
4734 */
4735 SSECustomerAlgorithm?: SSECustomerAlgorithm;
4736 /**
4737 * The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
4738 */
4739 SSECustomerKey?: SSECustomerKey;
4740 /**
4741 * The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
4742 */
4743 SSECustomerKeyMD5?: SSECustomerKeyMD5;
4744 /**
4745 * The expression that is used to query the object.
4746 */
4747 Expression: Expression;
4748 /**
4749 * The type of the provided expression (for example, SQL).
4750 */
4751 ExpressionType: ExpressionType;
4752 /**
4753 * Specifies if periodic request progress information should be enabled.
4754 */
4755 RequestProgress?: RequestProgress;
4756 /**
4757 * Describes the format of the data in the object that is being queried.
4758 */
4759 InputSerialization: InputSerialization;
4760 /**
4761 * Describes the format of the data that you want Amazon S3 to return in response.
4762 */
4763 OutputSerialization: OutputSerialization;
4764 /**
4765 * 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. ScanRangemay be used in the following ways: &lt;scanrange&gt;&lt;start&gt;50&lt;/start&gt;&lt;end&gt;100&lt;/end&gt;&lt;/scanrange&gt; - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero) &lt;scanrange&gt;&lt;start&gt;50&lt;/start&gt;&lt;/scanrange&gt; - process only the records starting after the byte 50 &lt;scanrange&gt;&lt;end&gt;50&lt;/end&gt;&lt;/scanrange&gt; - process only the records within the last 50 bytes of the file.
4766 */
4767 ScanRange?: ScanRange;
4768 }
4769 export interface SelectParameters {
4770 /**
4771 * Describes the serialization format of the object.
4772 */
4773 InputSerialization: InputSerialization;
4774 /**
4775 * The type of the provided expression (for example, SQL).
4776 */
4777 ExpressionType: ExpressionType;
4778 /**
4779 * The expression that is used to query the object.
4780 */
4781 Expression: Expression;
4782 /**
4783 * Describes how the results of the Select job are serialized.
4784 */
4785 OutputSerialization: OutputSerialization;
4786 }
4787 export type ServerSideEncryption = "AES256"|"aws:kms"|string;
4788 export interface ServerSideEncryptionByDefault {
4789 /**
4790 * Server-side encryption algorithm to use for the default encryption.
4791 */
4792 SSEAlgorithm: ServerSideEncryption;
4793 /**
4794 * KMS master key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.
4795 */
4796 KMSMasterKeyID?: SSEKMSKeyId;
4797 }
4798 export interface ServerSideEncryptionConfiguration {
4799 /**
4800 * Container for information about a particular server-side encryption configuration rule.
4801 */
4802 Rules: ServerSideEncryptionRules;
4803 }
4804 export interface ServerSideEncryptionRule {
4805 /**
4806 * Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
4807 */
4808 ApplyServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;
4809 }
4810 export type ServerSideEncryptionRules = ServerSideEncryptionRule[];
4811 export type Setting = boolean;
4812 export type Size = number;
4813 export interface SourceSelectionCriteria {
4814 /**
4815 * A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.
4816 */
4817 SseKmsEncryptedObjects?: SseKmsEncryptedObjects;
4818 }
4819 export interface SseKmsEncryptedObjects {
4820 /**
4821 * Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.
4822 */
4823 Status: SseKmsEncryptedObjectsStatus;
4824 }
4825 export type SseKmsEncryptedObjectsStatus = "Enabled"|"Disabled"|string;
4826 export type Start = number;
4827 export type StartAfter = string;
4828 export interface Stats {
4829 /**
4830 * The total number of object bytes scanned.
4831 */
4832 BytesScanned?: BytesScanned;
4833 /**
4834 * The total number of uncompressed object bytes processed.
4835 */
4836 BytesProcessed?: BytesProcessed;
4837 /**
4838 * The total number of bytes of records payload data returned.
4839 */
4840 BytesReturned?: BytesReturned;
4841 }
4842 export interface StatsEvent {
4843 /**
4844 * The Stats event details.
4845 */
4846 Details?: Stats;
4847 }
4848 export type StorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER"|"DEEP_ARCHIVE"|string;
4849 export interface StorageClassAnalysis {
4850 /**
4851 * Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
4852 */
4853 DataExport?: StorageClassAnalysisDataExport;
4854 }
4855 export interface StorageClassAnalysisDataExport {
4856 /**
4857 * The version of the output schema to use when exporting data. Must be V_1.
4858 */
4859 OutputSchemaVersion: StorageClassAnalysisSchemaVersion;
4860 /**
4861 * The place to store the data for an analysis.
4862 */
4863 Destination: AnalyticsExportDestination;
4864 }
4865 export type StorageClassAnalysisSchemaVersion = "V_1"|string;
4866 export type Suffix = string;
4867 export interface Tag {
4868 /**
4869 * Name of the tag.
4870 */
4871 Key: ObjectKey;
4872 /**
4873 * Value of the tag.
4874 */
4875 Value: Value;
4876 }
4877 export type TagCount = number;
4878 export type TagSet = Tag[];
4879 export interface Tagging {
4880 /**
4881 * A collection for a set of tags
4882 */
4883 TagSet: TagSet;
4884 }
4885 export type TaggingDirective = "COPY"|"REPLACE"|string;
4886 export type TaggingHeader = string;
4887 export type TargetBucket = string;
4888 export interface TargetGrant {
4889 /**
4890 * Container for the person being granted permissions.
4891 */
4892 Grantee?: Grantee;
4893 /**
4894 * Logging permissions assigned to the Grantee for the bucket.
4895 */
4896 Permission?: BucketLogsPermission;
4897 }
4898 export type TargetGrants = TargetGrant[];
4899 export type TargetPrefix = string;
4900 export type Tier = "Standard"|"Bulk"|"Expedited"|string;
4901 export type Token = string;
4902 export type TopicArn = string;
4903 export interface TopicConfiguration {
4904 Id?: NotificationId;
4905 /**
4906 * The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.
4907 */
4908 TopicArn: TopicArn;
4909 /**
4910 * The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide.
4911 */
4912 Events: EventList;
4913 Filter?: NotificationConfigurationFilter;
4914 }
4915 export interface TopicConfigurationDeprecated {
4916 Id?: NotificationId;
4917 /**
4918 * A collection of events related to objects
4919 */
4920 Events?: EventList;
4921 /**
4922 * Bucket event for which to send notifications.
4923 */
4924 Event?: Event;
4925 /**
4926 * Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.
4927 */
4928 Topic?: TopicArn;
4929 }
4930 export type TopicConfigurationList = TopicConfiguration[];
4931 export interface Transition {
4932 /**
4933 * Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
4934 */
4935 Date?: _Date;
4936 /**
4937 * Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
4938 */
4939 Days?: Days;
4940 /**
4941 * The storage class to which you want the object to transition.
4942 */
4943 StorageClass?: TransitionStorageClass;
4944 }
4945 export type TransitionList = Transition[];
4946 export type TransitionStorageClass = "GLACIER"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string;
4947 export type Type = "CanonicalUser"|"AmazonCustomerByEmail"|"Group"|string;
4948 export type URI = string;
4949 export type UploadIdMarker = string;
4950 export interface UploadPartCopyOutput {
4951 /**
4952 * The version of the source object that was copied, if you have enabled versioning on the source bucket.
4953 */
4954 CopySourceVersionId?: CopySourceVersionId;
4955 /**
4956 * Container for all response elements.
4957 */
4958 CopyPartResult?: CopyPartResult;
4959 /**
4960 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
4961 */
4962 ServerSideEncryption?: ServerSideEncryption;
4963 /**
4964 * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
4965 */
4966 SSECustomerAlgorithm?: SSECustomerAlgorithm;
4967 /**
4968 * 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.
4969 */
4970 SSECustomerKeyMD5?: SSECustomerKeyMD5;
4971 /**
4972 * 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.
4973 */
4974 SSEKMSKeyId?: SSEKMSKeyId;
4975 RequestCharged?: RequestCharged;
4976 }
4977 export interface UploadPartCopyRequest {
4978 /**
4979 * The bucket name.
4980 */
4981 Bucket: BucketName;
4982 /**
4983 * The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
4984 */
4985 CopySource: CopySource;
4986 /**
4987 * Copies the object if its entity tag (ETag) matches the specified tag.
4988 */
4989 CopySourceIfMatch?: CopySourceIfMatch;
4990 /**
4991 * Copies the object if it has been modified since the specified time.
4992 */
4993 CopySourceIfModifiedSince?: CopySourceIfModifiedSince;
4994 /**
4995 * Copies the object if its entity tag (ETag) is different than the specified ETag.
4996 */
4997 CopySourceIfNoneMatch?: CopySourceIfNoneMatch;
4998 /**
4999 * Copies the object if it hasn't been modified since the specified time.
5000 */
5001 CopySourceIfUnmodifiedSince?: CopySourceIfUnmodifiedSince;
5002 /**
5003 * 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.
5004 */
5005 CopySourceRange?: CopySourceRange;
5006 /**
5007 * Object key for which the multipart upload was initiated.
5008 */
5009 Key: ObjectKey;
5010 /**
5011 * Part number of part being copied. This is a positive integer between 1 and 10,000.
5012 */
5013 PartNumber: PartNumber;
5014 /**
5015 * Upload ID identifying the multipart upload whose part is being copied.
5016 */
5017 UploadId: MultipartUploadId;
5018 /**
5019 * Specifies the algorithm to use to when encrypting the object (for example, AES256).
5020 */
5021 SSECustomerAlgorithm?: SSECustomerAlgorithm;
5022 /**
5023 * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
5024 */
5025 SSECustomerKey?: SSECustomerKey;
5026 /**
5027 * 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.
5028 */
5029 SSECustomerKeyMD5?: SSECustomerKeyMD5;
5030 /**
5031 * Specifies the algorithm to use when decrypting the source object (for example, AES256).
5032 */
5033 CopySourceSSECustomerAlgorithm?: CopySourceSSECustomerAlgorithm;
5034 /**
5035 * 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.
5036 */
5037 CopySourceSSECustomerKey?: CopySourceSSECustomerKey;
5038 /**
5039 * 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.
5040 */
5041 CopySourceSSECustomerKeyMD5?: CopySourceSSECustomerKeyMD5;
5042 RequestPayer?: RequestPayer;
5043 }
5044 export interface UploadPartOutput {
5045 /**
5046 * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
5047 */
5048 ServerSideEncryption?: ServerSideEncryption;
5049 /**
5050 * Entity tag for the uploaded object.
5051 */
5052 ETag?: ETag;
5053 /**
5054 * If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
5055 */
5056 SSECustomerAlgorithm?: SSECustomerAlgorithm;
5057 /**
5058 * 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.
5059 */
5060 SSECustomerKeyMD5?: SSECustomerKeyMD5;
5061 /**
5062 * 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.
5063 */
5064 SSEKMSKeyId?: SSEKMSKeyId;
5065 RequestCharged?: RequestCharged;
5066 }
5067 export interface UploadPartRequest {
5068 /**
5069 * Object data.
5070 */
5071 Body?: Body;
5072 /**
5073 * Name of the bucket to which the multipart upload was initiated.
5074 */
5075 Bucket: BucketName;
5076 /**
5077 * Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
5078 */
5079 ContentLength?: ContentLength;
5080 /**
5081 * 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.
5082 */
5083 ContentMD5?: ContentMD5;
5084 /**
5085 * Object key for which the multipart upload was initiated.
5086 */
5087 Key: ObjectKey;
5088 /**
5089 * Part number of part being uploaded. This is a positive integer between 1 and 10,000.
5090 */
5091 PartNumber: PartNumber;
5092 /**
5093 * Upload ID identifying the multipart upload whose part is being uploaded.
5094 */
5095 UploadId: MultipartUploadId;
5096 /**
5097 * Specifies the algorithm to use to when encrypting the object (for example, AES256).
5098 */
5099 SSECustomerAlgorithm?: SSECustomerAlgorithm;
5100 /**
5101 * Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
5102 */
5103 SSECustomerKey?: SSECustomerKey;
5104 /**
5105 * 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.
5106 */
5107 SSECustomerKeyMD5?: SSECustomerKeyMD5;
5108 RequestPayer?: RequestPayer;
5109 }
5110 export type UserMetadata = MetadataEntry[];
5111 export type Value = string;
5112 export type VersionIdMarker = string;
5113 export interface VersioningConfiguration {
5114 /**
5115 * Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
5116 */
5117 MFADelete?: MFADelete;
5118 /**
5119 * The versioning state of the bucket.
5120 */
5121 Status?: BucketVersioningStatus;
5122 }
5123 export interface WebsiteConfiguration {
5124 /**
5125 * The name of the error document for the website.
5126 */
5127 ErrorDocument?: ErrorDocument;
5128 /**
5129 * The name of the index document for the website.
5130 */
5131 IndexDocument?: IndexDocument;
5132 /**
5133 * The redirect behavior for every request to this bucket's website endpoint. If you specify this property, you can't specify any other property.
5134 */
5135 RedirectAllRequestsTo?: RedirectAllRequestsTo;
5136 /**
5137 * Rules that define when a redirect is applied and the redirect behavior.
5138 */
5139 RoutingRules?: RoutingRules;
5140 }
5141 export type WebsiteRedirectLocation = string;
5142 export type Years = number;
5143 /**
5144 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
5145 */
5146 export type apiVersion = "2006-03-01"|"latest"|string;
5147 export interface ClientApiVersions {
5148 /**
5149 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
5150 */
5151 apiVersion?: apiVersion;
5152 }
5153 export type ClientConfiguration = ServiceConfigurationOptions & UseDualstackConfigOptions & ClientApiVersions;
5154 /**
5155 * Contains interfaces for use with the S3 client.
5156 */
5157 export import Types = S3;
5158}
5159export = S3;