diff --git a/clients/client-s3/src/S3.ts b/clients/client-s3/src/S3.ts index 3c00e17..754f458 100644 --- a/clients/client-s3/src/S3.ts +++ b/clients/client-s3/src/S3.ts @@ -431,44 +431,44 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; export class S3 extends S3Client { /** *

This action 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 action and ensure that - * the parts list is empty.

- *

For information about permissions required to use the multipart upload, see Multipart Upload and - * Permissions.

- *

The following operations are related to AbortMultipartUpload:

- * + * 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 action and ensure that + * the parts list is empty.

+ *

For information about permissions required to use the multipart upload, see Multipart Upload and + * Permissions.

+ *

The following operations are related to AbortMultipartUpload:

+ * */ public abortMultipartUpload( args: AbortMultipartUploadCommandInput, @@ -501,115 +501,115 @@ export class S3 extends S3Client { /** *

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 - * action 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 action 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 and - * Permissions.

- * - * - *

- * CompleteMultipartUpload has the following special errors:

- * - * - *

The following operations are related to CompleteMultipartUpload:

- * + *

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 + * action 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 action 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 and + * Permissions.

+ * + * + *

+ * CompleteMultipartUpload has the following special errors:

+ * + * + *

The following operations are related to CompleteMultipartUpload:

+ * */ public completeMultipartUpload( args: CompleteMultipartUploadCommandInput, @@ -642,175 +642,175 @@ export class S3 extends S3Client { /** *

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 action using this API. However, to copy - * 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.

- * - *

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.

- *

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 action 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.

- * - *

The copy request charge is based on the storage class and Region that you specify for - * the destination object. For pricing information, see Amazon S3 pricing.

- * - *

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, see Transfer Acceleration.

- * - *

- * Metadata - *

- *

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.

- *

To specify whether you want the object metadata copied from the source object or - * replaced with metadata provided in the request, you can optionally add the - * x-amz-metadata-directive header. When you grant permissions, you can use - * the s3:x-amz-metadata-directive condition key to enforce certain metadata - * behavior when objects are uploaded. For more information, see Specifying Conditions in a - * Policy in the Amazon S3 User Guide. For a complete list of - * Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for - * Amazon S3.

- *

- * - * x-amz-copy-source-if Headers - *

- *

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 - * following request parameters:

- * - *

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:

- * - * - *

If both 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:

- * - * - * - *

All headers with the x-amz- prefix, including - * x-amz-copy-source, must be signed.

- * - *

- * Server-side encryption - *

- *

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - * headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys - * (SSE-S3 or SSE-KMS) or a customer-provided encryption key. 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. For more information about server-side encryption, see Using - * Server-Side Encryption.

- *

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more - * information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

- *

- * Access Control List (ACL)-Specific Request - * Headers - *

- *

When copying an object, you can optionally use headers to grant ACL-based permissions. - * By default, all objects are private. Only the owner has full access control. When adding a - * new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups - * defined by Amazon S3. These permissions are then added to the ACL on the object. For more - * information, see Access Control List (ACL) Overview and Managing ACLs Using the REST - * API.

+ * + *

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 action using this API. However, to copy + * 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.

+ * + *

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.

+ *

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 action 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.

+ * + *

The copy request charge is based on the storage class and Region that you specify for + * the destination object. For pricing information, see Amazon S3 pricing.

+ * + *

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, see Transfer Acceleration.

+ * + *

+ * Metadata + *

+ *

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.

+ *

To specify whether you want the object metadata copied from the source object or + * replaced with metadata provided in the request, you can optionally add the + * x-amz-metadata-directive header. When you grant permissions, you can use + * the s3:x-amz-metadata-directive condition key to enforce certain metadata + * behavior when objects are uploaded. For more information, see Specifying Conditions in a + * Policy in the Amazon S3 User Guide. For a complete list of + * Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for + * Amazon S3.

+ *

+ * + * x-amz-copy-source-if Headers + *

+ *

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 + * following request parameters:

+ * + *

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:

+ * + * + *

If both 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:

+ * * - *

- * Storage Class Options - *

- *

You can use the CopyObject action 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 in the Amazon S3 User Guide.

- *

- * 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 - * RestoreObject.

- *

The following operations are related to CopyObject:

- * - *

For more information, see Copying - * Objects.

+ * + *

All headers with the x-amz- prefix, including + * x-amz-copy-source, must be signed.

+ * + *

+ * Server-side encryption + *

+ *

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related + * headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys + * (SSE-S3 or SSE-KMS) or a customer-provided encryption key. 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. For more information about server-side encryption, see Using + * Server-Side Encryption.

+ *

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more + * information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

+ *

+ * Access Control List (ACL)-Specific Request + * Headers + *

+ *

When copying an object, you can optionally use headers to grant ACL-based permissions. + * By default, all objects are private. Only the owner has full access control. When adding a + * new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups + * defined by Amazon S3. These permissions are then added to the ACL on the object. For more + * information, see Access Control List (ACL) Overview and Managing ACLs Using the REST + * API.

+ * + *

+ * Storage Class Options + *

+ *

You can use the CopyObject action 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 in the Amazon S3 User Guide.

+ *

+ * 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 + * RestoreObject.

+ *

The following operations are related to CopyObject:

+ * + *

For more information, see Copying + * Objects.

*/ public copyObject(args: CopyObjectCommandInput, options?: __HttpHandlerOptions): Promise; public copyObject(args: CopyObjectCommandInput, cb: (err: any, data?: CopyObjectCommandOutput) => void): void; @@ -837,124 +837,124 @@ export class S3 extends S3Client { /** *

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a - * valid Amazon Web Services 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 about bucket naming - * restrictions, see Bucket naming rules.

- *

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

- *

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 Europe (Ireland) - * Region. For more information, see Accessing a - * bucket.

- * - *

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.

- * + * + *

You can use either a canned ACL or specify access permissions explicitly. You cannot + * do both.

+ * + * + *

+ * Permissions + *

+ *

If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, + * authenticated-read, or if you specify access permissions explicitly through any other ACL, both + * s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the + * CreateBucket request is private, only s3:CreateBucket permission is needed.

+ *

If ObjectLockEnabledForBucket is set to true in your CreateBucket request, + * s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

+ * + *

The following operations are related to CreateBucket:

+ * */ public createBucket( args: CreateBucketCommandInput, @@ -984,266 +984,266 @@ export class S3 extends S3Client { /** *

This action 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 - * action 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 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 (Amazon Web Services 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 Amazon Web Services Key Management Service (Amazon Web Services - * 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 Amazon Web Services KMS CMK, the requester must - * have permission to the kms:Decrypt and kms:GenerateDataKey* - * 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. For more - * information, see Multipart upload API - * and permissions in the Amazon S3 User Guide.

- * - *

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account - * as the Amazon Web Services 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 Amazon Web Services managed - * encryption keys or provide your own encryption key.

- *
    - *
  • - *

    Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored - * in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services 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 Amazon Web Services managed CMK in Amazon Web Services KMS to protect the data.

    - *     - * - *

    All GET and PUT requests for an object protected by Amazon Web Services 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 Amazon Web Services - * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services - * 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 Amazon Web Services - * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services - * 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 Amazon Web Services 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 Amazon Web Services 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:

    + * 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 + * action 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 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 (Amazon Web Services 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 Amazon Web Services Key Management Service (Amazon Web Services + * 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 Amazon Web Services KMS CMK, the requester must + * have permission to the kms:Decrypt and kms:GenerateDataKey* + * 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. For more + * information, see Multipart upload API + * and permissions in the Amazon S3 User Guide.

    + * + *

    If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account + * as the Amazon Web Services 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 Amazon Web Services managed + * encryption keys or provide your own encryption key.

    + *
      + *
    • + *

      Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored + * in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services 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 Amazon Web Services managed CMK in Amazon Web Services KMS to protect the data.

      + *       + * + *

      All GET and PUT requests for an object protected by Amazon Web Services 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 Amazon Web Services + * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services + * 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 Amazon Web Services + * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services + * 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 Amazon Web Services 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 Amazon Web Services 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:

      + *
        + *
      • + *

        + * id – if the value specified is the canonical user ID + * of an Amazon Web Services account

        + *
        • + *
      • + *

        + * uri – if you are granting permissions to a predefined + * group

        + *
        • + *
      • + *

        + * emailAddress – if the value specified is the email + * address of an Amazon Web Services account

        + * + *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        *
          *
        • - *

          x-amz-grant-read

          + *

          US East (N. Virginia)

          *
          • *
        • - *

          x-amz-grant-write

          + *

          US West (N. California)

          *
          • *
        • - *

          x-amz-grant-read-acp

          + *

          US West (Oregon)

          *
          • *
        • - *

          x-amz-grant-write-acp

          + *

          Asia Pacific (Singapore)

          *
          • *
        • - *

          x-amz-grant-full-control

          + *

          Asia Pacific (Sydney)

          *
          • - *
        - *

        You specify each grantee as a type=value pair, where the type is one of - * the following:

        - *
          *
        • - *

          - * id – if the value specified is the canonical user ID - * of an Amazon Web Services account

          + *

          Asia Pacific (Tokyo)

          *
          • *
        • - *

          - * uri – if you are granting permissions to a predefined - * group

          + *

          Europe (Ireland)

          *
          • *
        • - *

          - * emailAddress – if the value specified is the email - * address of an Amazon Web Services account

          - * - *

          Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

          - *
            - *
          • - *

            US East (N. Virginia)

            - *
            • - *
          • - *

            US West (N. California)

            - *
            • - *
          • - *

            US West (Oregon)

            - *
            • - *
          • - *

            Asia Pacific (Singapore)

            - *
            • - *
          • - *

            Asia Pacific (Sydney)

            - *
            • - *
          • - *

            Asia Pacific (Tokyo)

            - *
            • - *
          • - *

            Europe (Ireland)

            - *
            • - *
          • - *

            South America (São Paulo)

            - *
            • - *
          - *

          For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

          - *           + *

          South America (São Paulo)

          *
          • *
        - *

        For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

        - *

        - * x-amz-grant-read: id="11112222333", id="444455556666" - *

        - *
        • - *
      + *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      + * + *
      • + *
    + *

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    + *

    + * x-amz-grant-read: id="11112222333", id="444455556666" + *

    + *
    • + *
* - *
- *
+ * + * * - *

The following operations are related to CreateMultipartUpload:

- * + *

The following operations are related to CreateMultipartUpload:

+ * */ public createMultipartUpload( args: CreateMultipartUploadCommandInput, @@ -1276,23 +1276,23 @@ export class S3 extends S3Client { /** *

Deletes the S3 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 - *

- * + * the bucket must be deleted before the bucket itself can be deleted.

+ * + *

+ * Related Resources + *

+ * */ public deleteBucket( args: DeleteBucketCommandInput, @@ -1322,35 +1322,35 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public deleteBucketAnalyticsConfiguration( args: DeleteBucketAnalyticsConfigurationCommandInput, @@ -1383,27 +1383,27 @@ export class S3 extends S3Client { /** *

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 S3 User Guide.

- * - *

- * Related Resources: - *

- * + *

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 S3 User Guide.

+ * + *

+ * Related Resources: + *

+ * */ public deleteBucketCors( args: DeleteBucketCorsCommandInput, @@ -1436,29 +1436,29 @@ export class S3 extends S3Client { /** *

This implementation of the DELETE action removes default encryption from the bucket. - * For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the - * Amazon S3 User 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 S3 User Guide.

- * - *

- * Related Resources - *

- * + * For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the + * Amazon S3 User 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 S3 User Guide.

+ * + *

+ * Related Resources + *

+ * */ public deleteBucketEncryption( args: DeleteBucketEncryptionCommandInput, @@ -1491,28 +1491,28 @@ export class S3 extends S3Client { /** *

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * DeleteBucketIntelligentTieringConfiguration include:

- * + *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * DeleteBucketIntelligentTieringConfiguration include:

+ * */ public deleteBucketIntelligentTieringConfiguration( args: DeleteBucketIntelligentTieringConfigurationCommandInput, @@ -1547,31 +1547,31 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public deleteBucketInventoryConfiguration( args: DeleteBucketInventoryConfigurationCommandInput, @@ -1604,31 +1604,31 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public deleteBucketLifecycle( args: DeleteBucketLifecycleCommandInput, @@ -1661,41 +1661,41 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public deleteBucketMetricsConfiguration( args: DeleteBucketMetricsConfigurationCommandInput, @@ -1728,24 +1728,24 @@ export class S3 extends S3Client { /** *

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:PutBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying - * Permissions in a Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to - * DeleteBucketOwnershipControls:

- * + * must have the s3:PutBucketOwnershipControls permission. For more information + * about Amazon S3 permissions, see Specifying + * Permissions in a Policy.

+ *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

+ *

The following operations are related to + * DeleteBucketOwnershipControls:

+ * */ public deleteBucketOwnershipControls( args: DeleteBucketOwnershipControlsCommandInput, @@ -1778,38 +1778,38 @@ export class S3 extends S3Client { /** *

This implementation of the DELETE action 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 - * Amazon Web Services 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 Amazon Web Services 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 - *

- * + * policy of a specified bucket. If you are using an identity other than the root user of the + * Amazon Web Services 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 Amazon Web Services 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 + *

+ * */ public deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, @@ -1842,31 +1842,31 @@ export class S3 extends S3Client { /** *

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 User Guide.

- * - *

The following operations are related to DeleteBucketReplication:

- * + *

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 User Guide.

+ * + *

The following operations are related to DeleteBucketReplication:

+ * */ public deleteBucketReplication( args: DeleteBucketReplicationCommandInput, @@ -1900,22 +1900,22 @@ export class S3 extends S3Client { /** *

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:

- * + *

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:

+ * */ public deleteBucketTagging( args: DeleteBucketTaggingCommandInput, @@ -1948,32 +1948,32 @@ export class S3 extends S3Client { /** *

This action 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 action 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:

- * + * 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 action 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:

+ * */ public deleteBucketWebsite( args: DeleteBucketWebsiteCommandInput, @@ -2006,36 +2006,36 @@ export class S3 extends S3Client { /** *

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 but will still respond that the command was successful.

- * - *

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 DELETE Object 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 action is related to DeleteObject:

- * + * which becomes the latest version of the object. If there isn't a null version, Amazon S3 does + * not remove any objects but will still respond that the command was successful.

+ * + *

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 DELETE Object 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 action is related to DeleteObject:

+ * */ public deleteObject( args: DeleteObjectCommandInput, @@ -2065,62 +2065,62 @@ export class S3 extends S3Client { /** *

This action 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 action 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 action 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 action supports two modes for the response: verbose and quiet. By default, the - * action 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 - * action encountered an error. For a successful deletion, the action does not return - * any information about the delete in the response body.

- * - *

When performing this action 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:

- * + * request. If you know the object keys that you want to delete, then this action 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 action 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 action supports two modes for the response: verbose and quiet. By default, the + * action 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 + * action encountered an error. For a successful deletion, the action does not return + * any information about the delete in the response body.

+ * + *

When performing this action 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:

+ * */ public deleteObjects( args: DeleteObjectsCommandInput, @@ -2153,30 +2153,30 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public deleteObjectTagging( args: DeleteObjectTaggingCommandInput, @@ -2209,34 +2209,34 @@ export class S3 extends S3Client { /** *

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 DeletePublicAccessBlock:

- * + * 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 DeletePublicAccessBlock:

+ * */ public deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, @@ -2269,32 +2269,32 @@ export class S3 extends S3Client { /** *

This implementation of the GET action 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 S3 User 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 S3 User Guide.

- *

- * Related Resources - *

- * + * 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 S3 User 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 S3 User Guide.

+ *

+ * Related Resources + *

+ * */ public getBucketAccelerateConfiguration( args: GetBucketAccelerateConfigurationCommandInput, @@ -2327,21 +2327,21 @@ export class S3 extends S3Client { /** *

This implementation of the GET action 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 - *

- * + * 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 + *

+ * */ public getBucketAcl( args: GetBucketAclCommandInput, @@ -2371,35 +2371,35 @@ export class S3 extends S3Client { /** *

This implementation of the GET action 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 S3 User Guide.

- *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis in the Amazon S3 User Guide.

- * - *

- * Related Resources - *

- * + * 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 S3 User Guide.

+ *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class + * Analysis in the Amazon S3 User Guide.

+ * + *

+ * Related Resources + *

+ * */ public getBucketAnalyticsConfiguration( args: GetBucketAnalyticsConfigurationCommandInput, @@ -2433,25 +2433,25 @@ export class S3 extends S3Client { /** *

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.

+ *

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.

+ *

For more information about cors, see Enabling + * Cross-Origin Resource Sharing.

* - *

The following operations are related to GetBucketCors:

- * + *

The following operations are related to GetBucketCors:

+ * */ public getBucketCors( args: GetBucketCorsCommandInput, @@ -2484,27 +2484,27 @@ export class S3 extends S3Client { /** *

Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not - * have a default encryption configuration, GetBucketEncryption returns - * ServerSideEncryptionConfigurationNotFoundError.

- *

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:

- * + * have a default encryption configuration, GetBucketEncryption returns + * ServerSideEncryptionConfigurationNotFoundError.

+ *

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:

+ * */ public getBucketEncryption( args: GetBucketEncryptionCommandInput, @@ -2537,28 +2537,28 @@ export class S3 extends S3Client { /** *

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * GetBucketIntelligentTieringConfiguration include:

- * + *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * GetBucketIntelligentTieringConfiguration include:

+ * */ public getBucketIntelligentTieringConfiguration( args: GetBucketIntelligentTieringConfigurationCommandInput, @@ -2593,35 +2593,35 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public getBucketInventoryConfiguration( args: GetBucketInventoryConfigurationCommandInput, @@ -2654,61 +2654,61 @@ export class S3 extends S3Client { /** * - *

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 using a previous version of the lifecycle configuration, it still - * works. For the earlier action, 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:

- * - *

The following operations are related to - * GetBucketLifecycleConfiguration:

- * + *

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 using a previous version of the lifecycle configuration, it still + * works. For the earlier action, 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:

+ * + *

The following operations are related to + * GetBucketLifecycleConfiguration:

+ * */ public getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, @@ -2741,26 +2741,26 @@ export class S3 extends S3Client { /** *

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.

+ * 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.

+ *

To use this implementation of the operation, you must be the bucket owner.

* - *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

+ *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

* - *

The following operations are related to GetBucketLocation:

- * + *

The following operations are related to GetBucketLocation:

+ * */ public getBucketLocation( args: GetBucketLocationCommandInput, @@ -2793,21 +2793,21 @@ export class S3 extends S3Client { /** *

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.

+ * that status. To use GET, you must be the bucket owner.

* - *

The following operations are related to GetBucketLogging:

- * + *

The following operations are related to GetBucketLogging:

+ * */ public getBucketLogging( args: GetBucketLoggingCommandInput, @@ -2840,42 +2840,42 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public getBucketMetricsConfiguration( args: GetBucketMetricsConfigurationCommandInput, @@ -2908,26 +2908,26 @@ export class S3 extends S3Client { /** *

Returns the notification configuration of a bucket.

- *

If notifications are not enabled on the bucket, the action 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 action is related to GetBucketNotification:

- * + *

If notifications are not enabled on the bucket, the action 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 action is related to GetBucketNotification:

+ * */ public getBucketNotificationConfiguration( args: GetBucketNotificationConfigurationCommandInput, @@ -2960,23 +2960,23 @@ export class S3 extends S3Client { /** *

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:GetBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying - * Permissions in a Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to GetBucketOwnershipControls:

- * + * must have the s3:GetBucketOwnershipControls permission. For more information + * about Amazon S3 permissions, see Specifying + * Permissions in a Policy.

+ *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

+ *

The following operations are related to GetBucketOwnershipControls:

+ * */ public getBucketOwnershipControls( args: GetBucketOwnershipControlsCommandInput, @@ -3009,32 +3009,32 @@ export class S3 extends S3Client { /** *

Returns the policy of a specified bucket. If you are using an identity other than the - * root user of the Amazon Web Services 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 Amazon Web Services 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 action is related to GetBucketPolicy:

- * + * root user of the Amazon Web Services 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 Amazon Web Services 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 action is related to GetBucketPolicy:

+ * */ public getBucketPolicy( args: GetBucketPolicyCommandInput, @@ -3067,36 +3067,36 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public getBucketPolicyStatus( args: GetBucketPolicyStatusCommandInput, @@ -3129,40 +3129,40 @@ export class S3 extends S3Client { /** *

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 S3 User Guide.

- * - *

This action 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 List of - * replication-related error codes - *

- * - * - *

The following operations are related to GetBucketReplication:

- * + * + *

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 S3 User Guide.

+ * + *

This action 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 List of + * replication-related error codes + *

+ * + * + *

The following operations are related to GetBucketReplication:

+ * */ public getBucketReplication( args: GetBucketReplicationCommandInput, @@ -3195,16 +3195,16 @@ export class S3 extends S3Client { /** *

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.

+ * operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

* - *

The following operations are related to GetBucketRequestPayment:

- * + *

The following operations are related to GetBucketRequestPayment:

+ * */ public getBucketRequestPayment( args: GetBucketRequestPaymentCommandInput, @@ -3237,37 +3237,37 @@ export class S3 extends S3Client { /** *

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:

- * - * - *

The following operations are related to GetBucketTagging:

- * + *

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:

+ * + * + *

The following operations are related to GetBucketTagging:

+ * */ public getBucketTagging( args: GetBucketTaggingCommandInput, @@ -3300,30 +3300,30 @@ export class S3 extends S3Client { /** *

Returns the versioning state of a bucket.

- *

To retrieve the versioning state of a bucket, you must be the bucket owner.

+ *

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.

+ *

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:

- * + *

The following operations are related to GetBucketVersioning:

+ * */ public getBucketVersioning( args: GetBucketVersioningCommandInput, @@ -3356,26 +3356,26 @@ export class S3 extends S3Client { /** *

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 action 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:

- * + * configure a bucket as website by adding a website configuration. For more information about + * hosting websites, see Hosting Websites on + * Amazon S3.

+ *

This GET action 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:

+ * */ public getBucketWebsite( args: GetBucketWebsiteCommandInput, @@ -3408,186 +3408,186 @@ export class S3 extends S3Client { /** *

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 S3 Glacier or - * S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or - * S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a - * copy using RestoreObject. Otherwise, this action 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 Amazon Web Services - * 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:

- * - *

For more information about SSE-C, see Server-Side Encryption (Using - * Customer-Provided Encryption Keys).

- * - *

Assuming you have the relevant permission to read object tags, 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 relevant read object (or version) 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.

- * - * - * - *

- * Versioning - *

- *

By default, the GET action returns the current version of an object. To return a - * different version, use the versionId subresource.

- * - * - * - * - * - * - *

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.

- * - * - * - *

- * 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.

+ * 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 S3 Glacier or + * S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or + * S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a + * copy using RestoreObject. Otherwise, this action 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 Amazon Web Services + * 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:

+ * + *

For more information about SSE-C, see Server-Side Encryption (Using + * Customer-Provided Encryption Keys).

+ * + *

Assuming you have the relevant permission to read object tags, 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 relevant read object (or version) 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.

+ * + * + * + *

+ * Versioning + *

+ *

By default, the GET action returns the current version of an object. To return a + * different version, use the versionId subresource.

* - *

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.

+ * + * + * + * + * + *

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.

* - *

The following operations are related to GetObject:

- * + * + *

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.

+ * + * + * + *

+ * 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:

+ * */ public getObject(args: GetObjectCommandInput, options?: __HttpHandlerOptions): Promise; public getObject(args: GetObjectCommandInput, cb: (err: any, data?: GetObjectCommandOutput) => void): void; @@ -3614,32 +3614,32 @@ export class S3 extends S3Client { /** *

Returns the access control list (ACL) of an object. To use this operation, you must have - * READ_ACP access to the object.

- *

This action is not supported by Amazon S3 on Outposts.

- *

- * 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:

- * + * READ_ACP access to the object.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

+ * 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:

+ * */ public getObjectAcl( args: GetObjectAclCommandInput, @@ -3669,7 +3669,7 @@ export class S3 extends S3Client { /** *

Gets an object's current Legal Hold status. For more information, see Locking Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ public getObjectLegalHold( args: GetObjectLegalHoldCommandInput, @@ -3702,9 +3702,9 @@ export class S3 extends S3Client { /** *

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.

+ * configuration will be applied by default to every new object placed in the specified + * bucket. For more information, see Locking + * Objects.

*/ public getObjectLockConfiguration( args: GetObjectLockConfigurationCommandInput, @@ -3737,7 +3737,7 @@ export class S3 extends S3Client { /** *

Retrieves an object's retention settings. For more information, see Locking Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ public getObjectRetention( args: GetObjectRetentionCommandInput, @@ -3770,33 +3770,33 @@ export class S3 extends S3Client { /** *

Returns the tag-set of an object. You send the GET request against the tagging - * subresource associated with the object.

+ * subresource associated with the object.

* - *

To use this operation, you must have permission to perform the - * s3:GetObjectTagging action. By default, the GET action 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.

+ *

To use this operation, you must have permission to perform the + * s3:GetObjectTagging action. By default, the GET action 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.

+ *

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.

+ *

For information about the Amazon S3 object tagging feature, see Object Tagging.

* - *

The following action is related to GetObjectTagging:

- * + *

The following action is related to GetObjectTagging:

+ * */ public getObjectTagging( args: GetObjectTaggingCommandInput, @@ -3829,22 +3829,22 @@ export class S3 extends S3Client { /** *

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - * distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

- * - *

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 a customer-provided encryption - * key.

- * - *

To use GET, you must have READ access to the object.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectTorrent:

- * + * distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

+ * + *

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 a customer-provided encryption + * key.

+ * + *

To use GET, you must have READ access to the object.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

The following action is related to GetObjectTorrent:

+ * */ public getObjectTorrent( args: GetObjectTorrentCommandInput, @@ -3877,45 +3877,45 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, @@ -3948,21 +3948,21 @@ export class S3 extends S3Client { /** *

This action is useful to determine if a bucket exists and you have permission to - * access it. The action returns a 200 OK if the bucket exists and you have - * permission to access it.

+ * access it. The action returns a 200 OK if the bucket exists and you have + * permission to access it.

* * - *

If the bucket does not exist or you do not have permission to access it, the HEAD request - * returns a generic 404 Not Found or 403 Forbidden code. A message body is not - * included, so you cannot determine the exception beyond these error codes.

+ *

If the bucket does not exist or you do not have permission to access it, the HEAD request + * returns a generic 404 Not Found or 403 Forbidden code. A message body is not + * included, so you cannot determine the exception beyond these error codes.

* - *

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.

+ *

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.

* * - *

To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.

+ *

To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.

*/ public headBucket(args: HeadBucketCommandInput, options?: __HttpHandlerOptions): Promise; public headBucket(args: HeadBucketCommandInput, cb: (err: any, data?: HeadBucketCommandOutput) => void): void; @@ -3989,117 +3989,117 @@ export class S3 extends S3Client { /** *

The HEAD action retrieves metadata from an object without returning the object - * itself. This action 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 action on an - * object. The response is identical to the GET response except that there is no - * response body. Because of this, if the HEAD request generates an error, it - * returns a generic 404 Not Found or 403 Forbidden code. It is not - * possible to retrieve the exact exception beyond these error codes.

- * - *

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 Amazon Web Services 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.

    - *
    • - *
  • - *

    - * The last modified property in this case is the creation date of the object.

    - *
    • - *
- * - * - * - *

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.

- * + * itself. This action 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 action on an + * object. The response is identical to the GET response except that there is no + * response body. Because of this, if the HEAD request generates an error, it + * returns a generic 404 Not Found or 403 Forbidden code. It is not + * possible to retrieve the exact exception beyond these error codes.

+ * + *

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 Amazon Web Services 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.

    + *
    • + *
  • *

    - * Permissions - *

    - *

    You need the relevant read object (or version) 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 action is related to HeadObject:

    - * + * The last modified property in this case is the creation date of the object.

    + *
    • + *
+ * + * + * + *

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 relevant read object (or version) 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 action is related to HeadObject:

+ * */ public headObject(args: HeadObjectCommandInput, options?: __HttpHandlerOptions): Promise; public headObject(args: HeadObjectCommandInput, cb: (err: any, data?: HeadObjectCommandOutput) => void): void; @@ -4126,45 +4126,45 @@ export class S3 extends S3Client { /** *

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - * configurations per bucket.

- * - *

This action 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:

- * + * configurations per bucket.

+ * + *

This action 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:

+ * */ public listBucketAnalyticsConfigurations( args: ListBucketAnalyticsConfigurationsCommandInput, @@ -4197,28 +4197,28 @@ export class S3 extends S3Client { /** *

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * ListBucketIntelligentTieringConfigurations include:

- * + *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * ListBucketIntelligentTieringConfigurations include:

+ * */ public listBucketIntelligentTieringConfigurations( args: ListBucketIntelligentTieringConfigurationsCommandInput, @@ -4253,44 +4253,44 @@ export class S3 extends S3Client { /** *

Returns a list of inventory configurations for the bucket. You can have up to 1,000 - * analytics configurations per bucket.

- * - *

This action 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:

- * + * analytics configurations per bucket.

+ * + *

This action 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:

+ * */ public listBucketInventoryConfigurations( args: ListBucketInventoryConfigurationsCommandInput, @@ -4323,46 +4323,46 @@ export class S3 extends S3Client { /** *

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 action 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:

- * + * 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 action 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:

+ * */ public listBucketMetricsConfigurations( args: ListBucketMetricsConfigurationsCommandInput, @@ -4421,56 +4421,56 @@ export class S3 extends S3Client { /** *

This action 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 action 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 and - * Permissions.

- * - *

The following operations are related to ListMultipartUploads:

- * + * multipart upload that has been initiated using the Initiate Multipart Upload request, but + * has not yet been completed or aborted.

+ * + *

This action 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 and + * Permissions.

+ * + *

The following operations are related to ListMultipartUploads:

+ * */ public listMultipartUploads( args: ListMultipartUploadsCommandInput, @@ -4503,43 +4503,43 @@ export class S3 extends S3Client { /** *

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 action 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:

- * + * 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 action 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:

+ * */ public listObjects(args: ListObjectsCommandInput, options?: __HttpHandlerOptions): Promise; public listObjects(args: ListObjectsCommandInput, cb: (err: any, data?: ListObjectsCommandOutput) => void): void; @@ -4566,47 +4566,47 @@ export class S3 extends S3Client { /** *

Returns some or all (up to 1,000) of the objects in a bucket with each request. 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. - * Objects are returned sorted in an ascending order of the respective key names in the list. - * For more information about listing objects, see Listing object keys - * programmatically - *

- * - *

To use this operation, you must have READ access to the bucket.

- * - *

To use this action in an 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 this action. 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:

- * + * 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. + * Objects are returned sorted in an ascending order of the respective key names in the list. + * For more information about listing objects, see Listing object keys + * programmatically + *

+ * + *

To use this operation, you must have READ access to the bucket.

+ * + *

To use this action in an 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 this action. 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:

+ * */ public listObjectsV2( args: ListObjectsV2CommandInput, @@ -4639,44 +4639,44 @@ export class S3 extends S3Client { /** *

Returns metadata about all versions of the objects in a bucket. You can also use request - * parameters as selection criteria to return metadata about a subset of all the object - * versions.

- * - *

- * To use this operation, you must have permissions to perform the - * s3:ListBucketVersions action. Be aware of the name difference. - *

- * - * - *

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.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following operations are related to - * ListObjectVersions:

- * + * parameters as selection criteria to return metadata about a subset of all the object + * versions.

+ * + *

+ * To use this operation, you must have permissions to perform the + * s3:ListBucketVersions action. Be aware of the name difference. + *

+ * + * + *

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.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

The following operations are related to + * ListObjectVersions:

+ * */ public listObjectVersions( args: ListObjectVersionsCommandInput, @@ -4709,50 +4709,50 @@ export class S3 extends S3Client { /** *

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 and - * Permissions.

- * - *

The following operations are related to ListParts:

- * + * 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 and + * Permissions.

+ * + *

The following operations are related to ListParts:

+ * */ public listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise; public listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void; @@ -4779,51 +4779,51 @@ export class S3 extends S3Client { /** *

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 action 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:

- * + * 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 action 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:

+ * */ public putBucketAccelerateConfiguration( args: PutBucketAccelerateConfigurationCommandInput, @@ -4856,195 +4856,195 @@ export class S3 extends S3Client { /** *

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.

+ * 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

    + *
    • + *
* - * - *

- * 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 (Amazon Web Services 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:

    + * + *

    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 (Amazon Web Services 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:

      + *
        + *
      • + *

        + * id – if the value specified is the canonical user ID of an Amazon Web Services account

        + *
        • + *
      • + *

        + * uri – if you are granting permissions to a predefined + * group

        + *
        • + *
      • + *

        + * emailAddress – if the value specified is the email address of + * an Amazon Web Services account

        + * + *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        *
          *
        • - *

          - * id – if the value specified is the canonical user ID of an Amazon Web Services account

          + *

          US East (N. Virginia)

          *
          • *
        • - *

          - * uri – if you are granting permissions to a predefined - * group

          + *

          US West (N. California)

          + *
          • + *
        • + *

          US West (Oregon)

          + *
          • + *
        • + *

          Asia Pacific (Singapore)

          + *
          • + *
        • + *

          Asia Pacific (Sydney)

          + *
          • + *
        • + *

          Asia Pacific (Tokyo)

          + *
          • + *
        • + *

          Europe (Ireland)

          *
          • *
        • - *

          - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

          - * - *

          Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

          - *
            - *
          • - *

            US East (N. Virginia)

            - *
            • - *
          • - *

            US West (N. California)

            - *
            • - *
          • - *

            US West (Oregon)

            - *
            • - *
          • - *

            Asia Pacific (Singapore)

            - *
            • - *
          • - *

            Asia Pacific (Sydney)

            - *
            • - *
          • - *

            Asia Pacific (Tokyo)

            - *
            • - *
          • - *

            Europe (Ireland)

            - *
            • - *
          • - *

            South America (São Paulo)

            - *
            • - *
          - *

          For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

          - *           + *

          South America (São Paulo)

          *
          • *
        - *

        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 Amazon Web Services accounts identified by their email addresses.

        - *

        - * x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", - * id="111122223333", id="555566667777" - *

        + *

        For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

        + *         + *
        • + *
      + *

      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 Amazon Web Services accounts identified by their email addresses.

      + *

      + * x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", + * id="111122223333", id="555566667777" + *

      * - *
      • - *
    - *

    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:

    + *
    • + *
+ *

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 the person's ID:

    + *

    + * <>ID<><>GranteesEmail<> + * + *

    + *

    DisplayName is optional and ignored in the request

    + *
    • + *
  • + *

    By URI:

    + *

    + * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> + *

    + *
    • + *
  • + *

    By Email address:

    + *

    + * <>Grantees@email.com<>lt;/Grantee> + *

    + *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object + * acl request, appears as the CanonicalUser.

    + * + *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    *
      *
    • - *

      By the person's ID:

      - *

      - * <>ID<><>GranteesEmail<> - * - *

      - *

      DisplayName is optional and ignored in the request

      + *

      US East (N. Virginia)

      *
      • *
    • - *

      By URI:

      - *

      - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

      + *

      US West (N. California)

      *
      • *
    • - *

      By Email address:

      - *

      - * <>Grantees@email.com<>lt;/Grantee> - *

      - *

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       + *

      US West (Oregon)

      *
      • - *
    - * - * - *

    - * Related Resources - *

    - *
      *
    • - *

      - * CreateBucket - *

      + *

      Asia Pacific (Singapore)

      *
      • *
    • - *

      - * DeleteBucket - *

      + *

      Asia Pacific (Sydney)

      *
      • *
    • - *

      - * GetObjectAcl - *

      + *

      Asia Pacific (Tokyo)

      + *
      • + *
    • + *

      Europe (Ireland)

      + *
      • + *
    • + *

      South America (São Paulo)

      *
      • *
    + *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    + *     + *
    • + *
+ * + * + *

+ * Related Resources + *

+ * */ public putBucketAcl( args: PutBucketAclCommandInput, @@ -5074,121 +5074,121 @@ export class S3 extends S3Client { /** *

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. - *

      - *
      • - *
    - *
    • - *
+ * 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 - *

- * + *

+ * Related Resources + *

+ * */ public putBucketAnalyticsConfiguration( args: PutBucketAnalyticsConfigurationCommandInput, @@ -5221,62 +5221,62 @@ export class S3 extends S3Client { /** *

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 S3 User Guide.

- * - *

- * Related Resources - *

- * + * 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 S3 User Guide.

+ * + *

+ * Related Resources + *

+ * */ public putBucketCors( args: PutBucketCorsCommandInput, @@ -5309,38 +5309,38 @@ export class S3 extends S3Client { /** *

This action uses the encryption subresource to configure default - * encryption and Amazon S3 Bucket Key for an existing bucket.

- *

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys - * (SSE-S3) or Amazon Web Services KMS customer master keys (SSE-KMS). If you specify default encryption - * using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default - * encryption, see Amazon S3 default bucket encryption - * in the Amazon S3 User Guide. For more information about S3 Bucket Keys, - * see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

- * - *

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services 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 S3 User Guide.

- * - *

- * Related Resources - *

- * + * encryption and Amazon S3 Bucket Key for an existing bucket.

+ *

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys + * (SSE-S3) or Amazon Web Services KMS customer master keys (SSE-KMS). If you specify default encryption + * using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default + * encryption, see Amazon S3 default bucket encryption + * in the Amazon S3 User Guide. For more information about S3 Bucket Keys, + * see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

+ * + *

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services 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 S3 User Guide.

+ * + *

+ * Related Resources + *

+ * */ public putBucketEncryption( args: PutBucketEncryptionCommandInput, @@ -5374,87 +5374,87 @@ export class S3 extends S3Client { /** *

Puts a S3 Intelligent-Tiering configuration to the specified bucket. * You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * PutBucketIntelligentTieringConfiguration include:

- * - * - *

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically - * move objects stored in the S3 Intelligent-Tiering storage class to the - * Archive Access or Deep Archive Access tier.

- * - * - *

- * 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:PutIntelligentTieringConfiguration bucket - * permission to set the configuration on the bucket.

      - *
      • - *
    - *
    • - *
+ *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * PutBucketIntelligentTieringConfiguration include:

+ * + * + *

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically + * move objects stored in the S3 Intelligent-Tiering storage class to the + * Archive Access or Deep Archive Access tier.

+ * + * + *

+ * 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:PutIntelligentTieringConfiguration bucket + * permission to set the configuration on the bucket.

      + *
      • + *
    + *
    • + *
*/ public putBucketIntelligentTieringConfiguration( args: PutBucketIntelligentTieringConfigurationCommandInput, @@ -5489,106 +5489,106 @@ export class S3 extends S3Client { /** *

This implementation of the PUT action 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 Amazon Web Services 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 S3 User 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 S3 User 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 - *

- * + * (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 Amazon Web Services 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 S3 User 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 S3 User 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 + *

+ * */ public putBucketInventoryConfiguration( args: PutBucketInventoryConfigurationCommandInput, @@ -5621,99 +5621,99 @@ export class S3 extends S3Client { /** *

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - * configuration. For information about lifecycle configuration, see Managing your storage - * lifecycle.

- * - * - *

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 Amazon Web Services 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

    - *
    • - *
- * + * configuration. For information about lifecycle configuration, see Managing your storage + * lifecycle.

* - *

For more information about permissions, see Managing Access Permissions to Your Amazon S3 - * Resources.

- * - *

The following are related to PutBucketLifecycleConfiguration:

- * + * + *

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 Amazon Web Services 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:

+ * */ public putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, @@ -5746,85 +5746,85 @@ export class S3 extends S3Client { /** *

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 Amazon Web Services 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:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request.

    - *
    • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<> - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - *
    • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
    • - *
+ * modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services 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:

    + *

    + * <>ID<><>GranteesEmail<> + * + *

    + *

    DisplayName is optional and ignored in the request.

    + *
    • + *
  • + *

    By Email address:

    + *

    + * <>Grantees@email.com<> + *

    + *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object + * acl request, appears as the CanonicalUser.

    + *
    • + *
  • + *

    By URI:

    + *

    + * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> + *

    + *
    • + *
* * - *

To enable logging, you use LoggingEnabled and its children request elements. To disable - * logging, you use an empty BucketLoggingStatus request element:

+ *

To enable logging, you use LoggingEnabled and its children request elements. To disable + * logging, you use an empty BucketLoggingStatus request element:

* - *

- * - *

+ *

+ * + *

* - *

For more information about server access logging, see Server Access Logging.

+ *

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.

+ *

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:

- * + *

The following operations are related to PutBucketLogging:

+ * */ public putBucketLogging( args: PutBucketLoggingCommandInput, @@ -5857,56 +5857,56 @@ export class S3 extends S3Client { /** *

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:

- * - * - *

- * 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

      - *
      • - *
    - *
    • - *
+ * 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:

+ * + * + *

+ * 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

      + *
      • + *
    + *
    • + *
*/ public putBucketMetricsConfiguration( args: PutBucketMetricsConfigurationCommandInput, @@ -5939,67 +5939,67 @@ export class S3 extends S3Client { /** *

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.

- * - *

- * - *

- *

- * - *

- *

This action 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 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 action will fail, and Amazon S3 will not add - * the configuration to your bucket.

- * + * 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.

+ * + *

+ * + *

+ *

+ * + *

+ *

This action 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 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.

* - *

- * 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 action is related to - * PutBucketNotificationConfiguration:

- * + * + *

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 action 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 action is related to + * PutBucketNotificationConfiguration:

+ * */ public putBucketNotificationConfiguration( args: PutBucketNotificationConfigurationCommandInput, @@ -6032,22 +6032,22 @@ export class S3 extends S3Client { /** *

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this - * operation, you must have the s3:PutBucketOwnershipControls permission. For - * more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to PutBucketOwnershipControls:

- * + * operation, you must have the s3:PutBucketOwnershipControls permission. For + * more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

+ *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

+ *

The following operations are related to PutBucketOwnershipControls:

+ * */ public putBucketOwnershipControls( args: PutBucketOwnershipControlsCommandInput, @@ -6080,35 +6080,35 @@ export class S3 extends S3Client { /** *

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than - * the root user of the Amazon Web Services 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 Amazon Web Services 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, see Bucket policy examples.

- * - *

The following operations are related to PutBucketPolicy:

- * + * the root user of the Amazon Web Services 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 Amazon Web Services 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, see Bucket policy examples.

+ * + *

The following operations are related to PutBucketPolicy:

+ * */ public putBucketPolicy( args: PutBucketPolicyCommandInput, @@ -6141,75 +6141,75 @@ export class S3 extends S3Client { /** *

Creates a replication configuration or replaces an existing one. For more information, - * see Replication in the Amazon S3 User Guide.

- * - *

Specify the replication configuration in the request body. In the replication - * configuration, you provide the name of the destination bucket or buckets 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.

- * - *

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.

- * - *

If you are using an earlier version of the replication configuration, Amazon S3 handles - * replication of delete markers differently. For more information, see Backward Compatibility.

- * - *

For information about enabling versioning on a bucket, see Using Versioning.

+ * see Replication in the Amazon S3 User Guide.

* - *

- * 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 Amazon Web Services KMS. To replicate Amazon Web Services 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 Amazon Web Services KMS.

- * - *

For information on PutBucketReplication errors, see List of - * replication-related error codes - *

+ *

Specify the replication configuration in the request body. In the replication + * configuration, you provide the name of the destination bucket or buckets 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.

* - *

- * Permissions - *

- *

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration - * permissions for the bucket. - *

- *

By default, a resource owner, in this case the Amazon Web Services 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.

- * - *

To perform this operation, the user or role performing the action must have the - * iam:PassRole permission.

- * - * - *

The following operations are related to PutBucketReplication:

- * + * + *

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.

+ * + *

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.

+ * + *

If you are using an earlier version of the replication configuration, Amazon S3 handles + * replication of delete markers differently. For more information, see Backward Compatibility.

+ * + *

For information about enabling versioning on a bucket, see Using Versioning.

+ * + *

+ * 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 Amazon Web Services KMS. To replicate Amazon Web Services 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 Amazon Web Services KMS.

+ * + *

For information on PutBucketReplication errors, see List of + * replication-related error codes + *

+ * + *

+ * Permissions + *

+ *

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration + * permissions for the bucket. + *

+ *

By default, a resource owner, in this case the Amazon Web Services 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.

+ * + *

To perform this operation, the user or role performing the action must have the + * iam:PassRole permission.

+ * + * + *

The following operations are related to PutBucketReplication:

+ * */ public putBucketReplication( args: PutBucketReplicationCommandInput, @@ -6242,24 +6242,24 @@ export class S3 extends S3Client { /** *

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:

- * + * 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:

+ * */ public putBucketRequestPayment( args: PutBucketRequestPaymentCommandInput, @@ -6292,84 +6292,84 @@ export class S3 extends S3Client { /** *

Sets the tags for a bucket.

- *

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign - * up to get your Amazon Web Services 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 and Using Cost Allocation in Amazon S3 Bucket - * Tags.

- * - * - *

- * When this operation sets the tags for a bucket, it will overwrite any current tags the - * bucket already has. You cannot use this operation to add tags to an existing list of 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 - *

    - * - *
    • - *
  • - *

    Error code: MalformedXMLError - *

    - *
      - *
    • - *

      Description: The XML provided does not match the schema.

      - *
      • - *
    - *
    • - *
  • - *

    Error code: OperationAbortedError - *

    - *
      - *
    • - *

      Description: A conflicting conditional action 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.

      - *
      • - *
    - *
    • - *
+ *

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign + * up to get your Amazon Web Services 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 and Using Cost Allocation in Amazon S3 Bucket + * Tags.

* - * - *

The following operations are related to PutBucketTagging:

- * + * + *

+ * When this operation sets the tags for a bucket, it will overwrite any current tags the + * bucket already has. You cannot use this operation to add tags to an existing list of 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 + *

    + * + *
    • + *
  • + *

    Error code: MalformedXMLError + *

    + *
      + *
    • + *

      Description: The XML provided does not match the schema.

      + *
      • + *
    + *
    • + *
  • + *

    Error code: OperationAbortedError + *

    + *
      + *
    • + *

      Description: A conflicting conditional action 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:

+ * */ public putBucketTagging( args: PutBucketTaggingCommandInput, @@ -6402,54 +6402,54 @@ export class S3 extends S3Client { /** *

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 - *

- * + * 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 + *

+ * */ public putBucketVersioning( args: PutBucketVersioningCommandInput, @@ -6482,131 +6482,131 @@ export class S3 extends S3Client { /** *

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 action 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 - *

    - *
    • - *
+ * 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 action 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 + *

    + *
    • + *
* - *

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more - * than 50 routing rules, you can use object redirect. For more information, see Configuring an - * Object Redirect in the Amazon S3 User Guide.

+ *

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more + * than 50 routing rules, you can use object redirect. For more information, see Configuring an + * Object Redirect in the Amazon S3 User Guide.

*/ public putBucketWebsite( args: PutBucketWebsiteCommandInput, @@ -6639,100 +6639,100 @@ export class S3 extends S3Client { /** *

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 successfully complete the PutObject request, you must have the - * s3:PutObject in your IAM permissions.

    - *
    • - *
  • - *

    To successfully change the objects acl of your PutObject request, - * you must have the s3:PutObjectAcl in your IAM permissions.

    - *
    • - *
  • - *

    The Content-MD5 header is required for any request to upload an object - * with a retention period configured using Amazon S3 Object Lock. For more information about - * Amazon S3 Object Lock, see Amazon S3 Object Lock Overview - * in the Amazon S3 User Guide.

    - *
    • - *
- * + * to it.

* - *

- * Server-side Encryption - *

- *

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 Amazon Web Services - * managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side - * Encryption.

- *

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable - * an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the - * Amazon S3 User Guide.

- *

- * Access Control List (ACL)-Specific Request - * Headers - *

- *

You can use headers to grant ACL- based permissions. By default, all objects are - * private. Only the owner has full access control. When adding a new object, you can grant - * permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These - * permissions are then added to the ACL on the object. For more information, see Access Control List - * (ACL) Overview and Managing ACLs Using the REST - * API.

* - *

- * 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. Depending on - * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses - * the OUTPOSTS Storage Class. For more information, see Storage Classes in the - * Amazon S3 User Guide.

+ *

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.

* - *

- * 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. When you enable - * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object - * simultaneously, it stores all of the objects.

- *

For more information about versioning, see Adding Objects to - * Versioning Enabled Buckets. For information about returning the versioning state - * of a bucket, see GetBucketVersioning.

- * - * - *

- * Related Resources - *

- * + *

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 successfully complete the PutObject request, you must have the + * s3:PutObject in your IAM permissions.

    + *
    • + *
  • + *

    To successfully change the objects acl of your PutObject request, + * you must have the s3:PutObjectAcl in your IAM permissions.

    + *
    • + *
  • + *

    The Content-MD5 header is required for any request to upload an object + * with a retention period configured using Amazon S3 Object Lock. For more information about + * Amazon S3 Object Lock, see Amazon S3 Object Lock Overview + * in the Amazon S3 User Guide.

    + *
    • + *
+ * + * + *

+ * Server-side Encryption + *

+ *

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 Amazon Web Services + * managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side + * Encryption.

+ *

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable + * an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the + * Amazon S3 User Guide.

+ *

+ * Access Control List (ACL)-Specific Request + * Headers + *

+ *

You can use headers to grant ACL- based permissions. By default, all objects are + * private. Only the owner has full access control. When adding a new object, you can grant + * permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These + * permissions are then added to the ACL on the object. For more information, see Access Control List + * (ACL) Overview and Managing ACLs Using the REST + * API.

+ * + *

+ * 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. Depending on + * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses + * the OUTPOSTS Storage Class. For more information, see Storage Classes in the + * Amazon S3 User 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. When you enable + * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object + * simultaneously, it stores all of the objects.

+ *

For more information about versioning, see Adding Objects to + * Versioning Enabled Buckets. For information about returning the versioning state + * of a bucket, see GetBucketVersioning.

+ * + * + *

+ * Related Resources + *

+ * */ public putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; public putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; @@ -6759,184 +6759,184 @@ export class S3 extends S3Client { /** *

Uses the acl subresource to set the access control list (ACL) permissions - * for a new or existing object in an S3 bucket. You must have WRITE_ACP - * permission to set the ACL of an object. For more information, see What - * permissions can I grant? in the Amazon S3 User Guide.

- *

This action is not supported by Amazon S3 on Outposts.

- *

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. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

- * - * - * - *

- * 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 (Amazon Web Services 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:

    + * for a new or existing object in an S3 bucket. You must have WRITE_ACP + * permission to set the ACL of an object. For more information, see What + * permissions can I grant? in the Amazon S3 User Guide.

    + *

    This action is not supported by Amazon S3 on Outposts.

    + *

    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. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

    + * + * + * + *

    + * 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 (Amazon Web Services 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:

      + *
        + *
      • + *

        + * id – if the value specified is the canonical user ID of an Amazon Web Services account

        + *
        • + *
      • + *

        + * uri – if you are granting permissions to a predefined + * group

        + *
        • + *
      • + *

        + * emailAddress – if the value specified is the email address of + * an Amazon Web Services account

        + * + *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        *
          *
        • - *

          - * id – if the value specified is the canonical user ID of an Amazon Web Services account

          + *

          US East (N. Virginia)

          *
          • *
        • - *

          - * uri – if you are granting permissions to a predefined - * group

          + *

          US West (N. California)

          + *
          • + *
        • + *

          US West (Oregon)

          + *
          • + *
        • + *

          Asia Pacific (Singapore)

          + *
          • + *
        • + *

          Asia Pacific (Sydney)

          + *
          • + *
        • + *

          Asia Pacific (Tokyo)

          + *
          • + *
        • + *

          Europe (Ireland)

          *
          • *
        • - *

          - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

          - * - *

          Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

          - *
            - *
          • - *

            US East (N. Virginia)

            - *
            • - *
          • - *

            US West (N. California)

            - *
            • - *
          • - *

            US West (Oregon)

            - *
            • - *
          • - *

            Asia Pacific (Singapore)

            - *
            • - *
          • - *

            Asia Pacific (Sydney)

            - *
            • - *
          • - *

            Asia Pacific (Tokyo)

            - *
            • - *
          • - *

            Europe (Ireland)

            - *
            • - *
          • - *

            South America (São Paulo)

            - *
            • - *
          - *

          For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

          - *           + *

          South America (São Paulo)

          *
          • *
        - *

        For example, the following x-amz-grant-read header grants list - * objects permission to the two Amazon Web Services accounts identified by their email - * addresses.

        - *

        - * x-amz-grant-read: emailAddress="xyz@amazon.com", - * emailAddress="abc@amazon.com" - *

        + *

        For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

        + *         + *
        • + *
      + *

      For example, the following x-amz-grant-read header grants list + * objects permission to the two Amazon Web Services 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:

    + *
    • + *
+ *

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 the person's ID:

    + *

    + * <>ID<><>GranteesEmail<> + * + *

    + *

    DisplayName is optional and ignored in the request.

    + *
    • + *
  • + *

    By URI:

    + *

    + * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> + *

    + *
    • + *
  • + *

    By Email address:

    + *

    + * <>Grantees@email.com<>lt;/Grantee> + *

    + *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object + * acl request, appears as the CanonicalUser.

    + * + *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    *
      *
    • - *

      By the person's ID:

      - *

      - * <>ID<><>GranteesEmail<> - * - *

      - *

      DisplayName is optional and ignored in the request.

      + *

      US East (N. Virginia)

      *
      • *
    • - *

      By URI:

      - *

      - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

      + *

      US West (N. California)

      *
      • *
    • - *

      By Email address:

      - *

      - * <>Grantees@email.com<>lt;/Grantee> - *

      - *

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       + *

      US West (Oregon)

      *
      • - *
    - *

    - * 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 - *

      + *

      Asia Pacific (Singapore)

      *
      • *
    • - *

      - * GetObject - *

      + *

      Asia Pacific (Sydney)

      *
      • - *
    - */ - public putObjectAcl( + *
  • + *

    Asia Pacific (Tokyo)

    + *
    • + *
  • + *

    Europe (Ireland)

    + *
    • + *
  • + *

    South America (São Paulo)

    + *
    • + *
+ *

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

+ * + * + * + *

+ * 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 + *

+ * + */ + public putObjectAcl( args: PutObjectAclCommandInput, options?: __HttpHandlerOptions ): Promise; @@ -6964,9 +6964,9 @@ export class S3 extends S3Client { /** *

Applies a Legal Hold configuration to the specified object. For more information, see - * Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ * Locking + * Objects.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ public putObjectLegalHold( args: PutObjectLegalHoldCommandInput, @@ -6999,26 +6999,26 @@ export class S3 extends S3Client { /** *

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. For more information, see Locking Objects. + * Object Lock configuration will be applied by default to every new object placed in the + * specified bucket. For more information, see Locking Objects. *

- * - *
    - *
  • - *

    The DefaultRetention settings require both a mode and a - * period.

    - *
    • - *
  • - *

    The DefaultRetention period can be either Days - * or Years but you must select one. You cannot specify Days - * and Years at the same time.

    - *
    • - *
  • - *

    You can only enable Object Lock for new buckets. If you want to turn on - * Object Lock for an existing bucket, contact Amazon Web Services Support.

    - *
    • - *
- * + * + *
    + *
  • + *

    The DefaultRetention settings require both a mode and a + * period.

    + *
    • + *
  • + *

    The DefaultRetention period can be either Days + * or Years but you must select one. You cannot specify Days + * and Years at the same time.

    + *
    • + *
  • + *

    You can only enable Object Lock for new buckets. If you want to turn on + * Object Lock for an existing bucket, contact Amazon Web Services Support.

    + *
    • + *
+ * */ public putObjectLockConfiguration( args: PutObjectLockConfigurationCommandInput, @@ -7051,18 +7051,18 @@ export class S3 extends S3Client { /** *

Places an Object Retention configuration on an object. For more information, see Locking Objects. - * Users or accounts require the s3:PutObjectRetention permission in order to place - * an Object Retention configuration on objects. Bypassing a Governance Retention configuration - * requires the s3:BypassGovernanceRetention permission. - *

- *

This action is not supported by Amazon S3 on Outposts.

- * - *

- * Permissions - *

- *

When the Object Lock retention mode is set to compliance, you need s3:PutObjectRetention and - * s3:BypassGovernanceRetention permissions. For other requests to PutObjectRetention, - * only s3:PutObjectRetention permissions are required.

+ * Users or accounts require the s3:PutObjectRetention permission in order to place + * an Object Retention configuration on objects. Bypassing a Governance Retention configuration + * requires the s3:BypassGovernanceRetention permission. + *

+ *

This action is not supported by Amazon S3 on Outposts.

+ * + *

+ * Permissions + *

+ *

When the Object Lock retention mode is set to compliance, you need s3:PutObjectRetention and + * s3:BypassGovernanceRetention permissions. For other requests to PutObjectRetention, + * only s3:PutObjectRetention permissions are required.

*/ public putObjectRetention( args: PutObjectRetentionCommandInput, @@ -7095,109 +7095,109 @@ export class S3 extends S3Client { /** *

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.

+ *

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.

+ *

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 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.

+ *

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.

+ *

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 action 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. - *

      - *
      • - *
    - *
    • - *
+ *

+ * 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 action 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 - *

- * + *

+ * Related Resources + *

+ * */ public putObjectTagging( args: PutObjectTaggingCommandInput, @@ -7230,50 +7230,50 @@ export class S3 extends S3Client { /** *

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.

+ * 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.

- * + * + *

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".

+ *

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

* * * - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * */ public putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, @@ -7306,297 +7306,297 @@ export class S3 extends S3Client { /** *

Restores an archived copy of an object back into Amazon S3

- *

This action is not supported by Amazon S3 on Outposts.

- *

This action 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 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 S3 User 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 S3 User 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 Amazon Web Services Region as the bucket that contains the archive object that is - * being queried. The Amazon Web Services 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 S3 User Guide.

    - *

    For more information about the S3 structure in the request body, see - * the following:

    - * - *
    • - *
  • - *

    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 > 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 S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and - * S3 Glacier Select in the Amazon S3 User 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 objects - *

- *

Objects that you archive to the S3 Glacier or - * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or - * S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in - * Archive Access or Deep Archive Access tiers you must first initiate a restore request, and - * then wait until the object is moved into the Frequent Access tier. For objects in - * S3 Glacier or S3 Glacier Deep Archive storage classes you must - * first initiate a restore request, and then wait until a temporary copy of the object is - * available. To access an archived object, you must restore the object for the duration - * (number of days) that you specify.

- *

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.

- *

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 S3 Glacier - * storage class or S3 Intelligent-Tiering Archive tier 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 is 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 objects stored in the S3 Glacier Deep Archive - * storage class or S3 Intelligent-Tiering Deep Archive tier.

    - *
    • - *
  • - *

    - * - * Standard - * - Standard retrievals allow - * you to access any of your archived objects within several hours. This is the default - * option for retrieval requests that do not specify the retrieval option. Standard - * retrievals typically finish within 3–5 hours for objects stored in the - * S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They - * typically finish within 12 hours for objects stored in the - * S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. - * Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

    - *
    • - *
  • - *

    - * - * Bulk - * - Bulk retrievals are the - * lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, - * even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 - * hours for objects stored in the S3 Glacier storage class or - * S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored - * in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. - * Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

    - *
    • - *
- *

For more information about archive retrieval options and provisioned capacity for - * Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

- *

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed - * while it is in progress. For more information, see - * Upgrading the speed of an in-progress restore in the - * Amazon S3 User 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 S3 User 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 S3 User Guide.

- *

- * Responses - *

- *

A successful action returns either the 200 OK or 202 - * Accepted status code.

- *
    - *
  • - *

    If the object is not previously restored, then Amazon S3 returns 202 - * Accepted in the response.

    - *
    • - *
  • - *

    If the object 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: 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 - * S3 Standard or Bulk retrievals.) - *

      - *
      • - *
    • - *

      - * HTTP Status Code: 503 - *

      - *
      • - *
    • - *

      - * SOAP Fault Code Prefix: N/A - *

      - *
      • - *
    - *
    • - *
- * - *

- * Related Resources - *

- * + *

This action is not supported by Amazon S3 on Outposts.

+ *

This action 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 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 S3 User 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 S3 User 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 Amazon Web Services Region as the bucket that contains the archive object that is + * being queried. The Amazon Web Services 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 S3 User Guide.

    + *

    For more information about the S3 structure in the request body, see + * the following:

    + * + *
    • + *
  • + *

    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 > 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 S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and + * S3 Glacier Select in the Amazon S3 User 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 objects + *

+ *

Objects that you archive to the S3 Glacier or + * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or + * S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in + * Archive Access or Deep Archive Access tiers you must first initiate a restore request, and + * then wait until the object is moved into the Frequent Access tier. For objects in + * S3 Glacier or S3 Glacier Deep Archive storage classes you must + * first initiate a restore request, and then wait until a temporary copy of the object is + * available. To access an archived object, you must restore the object for the duration + * (number of days) that you specify.

+ *

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.

+ *

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 S3 Glacier + * storage class or S3 Intelligent-Tiering Archive tier 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 is 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 objects stored in the S3 Glacier Deep Archive + * storage class or S3 Intelligent-Tiering Deep Archive tier.

    + *
    • + *
  • + *

    + * + * Standard + * - Standard retrievals allow + * you to access any of your archived objects within several hours. This is the default + * option for retrieval requests that do not specify the retrieval option. Standard + * retrievals typically finish within 3–5 hours for objects stored in the + * S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They + * typically finish within 12 hours for objects stored in the + * S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. + * Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

    + *
    • + *
  • + *

    + * + * Bulk + * - Bulk retrievals are the + * lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, + * even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 + * hours for objects stored in the S3 Glacier storage class or + * S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored + * in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. + * Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

    + *
    • + *
+ *

For more information about archive retrieval options and provisioned capacity for + * Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

+ *

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed + * while it is in progress. For more information, see + * Upgrading the speed of an in-progress restore in the + * Amazon S3 User 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 S3 User 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 S3 User Guide.

+ *

+ * Responses + *

+ *

A successful action returns either the 200 OK or 202 + * Accepted status code.

+ *
    + *
  • + *

    If the object is not previously restored, then Amazon S3 returns 202 + * Accepted in the response.

    + *
    • + *
  • + *

    If the object 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: 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 + * S3 Standard or Bulk retrievals.) + *

      + *
      • + *
    • + *

      + * HTTP Status Code: 503 + *

      + *
      • + *
    • + *

      + * SOAP Fault Code Prefix: N/A + *

      + *
      • + *
    + *
    • + *
+ * + *

+ * Related Resources + *

+ * */ public restoreObject( args: RestoreObjectCommandInput, @@ -7629,122 +7629,122 @@ export class S3 extends S3Client { /** *

This action 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.

- *

This action is not supported by Amazon S3 on Outposts.

- *

For more information about Amazon S3 Select, - * see Selecting Content from - * Objects in the Amazon S3 User Guide.

- *

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select - * and S3 Glacier Select in the Amazon S3 User 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 S3 User 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 S3 User Guide.

    - *

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and - * customer master keys (CMKs) stored in Amazon Web Services 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 S3 User 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 Appendix: SelectObjectContent - * Response.

- * - *

- *

- * GetObject Support - *

- *

The SelectObjectContent action does not support the following - * GetObject functionality. For more information, see GetObject.

- *
    - *
  • - *

    - * Range: Although you can specify a scan range for an Amazon S3 Select request - * (see SelectObjectContentRequest - ScanRange in the request parameters), - * 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 S3 User Guide.

    - *
    • - *
- *

- *

- * Special Errors - *

- * - *

For a list of special errors for this operation, see List of - * SELECT Object Content Error Codes - *

- *

- * Related Resources - *

- * + * 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.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

For more information about Amazon S3 Select, + * see Selecting Content from + * Objects in the Amazon S3 User Guide.

+ *

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select + * and S3 Glacier Select in the Amazon S3 User 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 S3 User 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 S3 User Guide.

    + *

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and + * customer master keys (CMKs) stored in Amazon Web Services 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 S3 User 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 Appendix: SelectObjectContent + * Response.

+ * + *

+ *

+ * GetObject Support + *

+ *

The SelectObjectContent action does not support the following + * GetObject functionality. For more information, see GetObject.

+ *
    + *
  • + *

    + * Range: Although you can specify a scan range for an Amazon S3 Select request + * (see SelectObjectContentRequest - ScanRange in the request parameters), + * 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 S3 User Guide.

    + *
    • + *
+ *

+ *

+ * Special Errors + *

+ * + *

For a list of special errors for this operation, see List of + * SELECT Object Content Error Codes + *

+ *

+ * Related Resources + *

+ * */ public selectObjectContent( args: SelectObjectContentCommandInput, @@ -7777,143 +7777,143 @@ export class S3 extends S3Client { /** *

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.

- * - *

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the - * x-amz-content-sha256 header as a checksum instead of - * Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version - * 4).

- * - * - * - *

- * 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 S3 User Guide .

- *

For information on the permissions required to use the multipart upload API, go to - * Multipart Upload and - * Permissions in the Amazon S3 User 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 Amazon Web Services 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 S3 User 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 - *

      - *
      • - *
    - *
    • - *
+ * + *

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.

+ * + *

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the + * x-amz-content-sha256 header as a checksum instead of + * Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version + * 4).

+ * + * + * + *

+ * 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 S3 User Guide .

+ *

For information on the permissions required to use the multipart upload API, go to + * Multipart Upload and + * Permissions in the Amazon S3 User 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 Amazon Web Services 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 S3 User 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 - *

- * + *

+ * Related Resources + *

+ * */ public uploadPart(args: UploadPartCommandInput, options?: __HttpHandlerOptions): Promise; public uploadPart(args: UploadPartCommandInput, cb: (err: any, data?: UploadPartCommandOutput) => void): void; @@ -7940,184 +7940,184 @@ export class S3 extends S3Client { /** *

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 S3 User Guide.

- * - *

Instead of using an existing object as part data, you might use the UploadPart - * action 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 S3 User Guide.

    - *
    • - *
  • - *

    For information about permissions required to use the multipart upload API, see - * Multipart Upload and - * Permissions in the Amazon S3 User Guide.

    - *
    • - *
  • - *

    For information about copying objects using a single atomic action vs. the - * multipart upload, see Operations on - * Objects in the Amazon S3 User 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 - *

+ * 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 S3 User Guide.

+ * + *

Instead of using an existing object as part data, you might use the UploadPart + * action 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 S3 User Guide.

    + *
    • + *
  • + *

    For information about permissions required to use the multipart upload API, see + * Multipart Upload and + * Permissions in the Amazon S3 User Guide.

    + *
    • + *
  • + *

    For information about copying objects using a single atomic action vs. the + * multipart upload, see Operations on + * Objects in the Amazon S3 User 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. + *

    * - *

    - * 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 - *

        - *
        • - *
      - *
      • - *
    + *
    • + *
  • + *

    + * 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 - *

- * + *

+ * Related Resources + *

+ * */ public uploadPartCopy( args: UploadPartCopyCommandInput, @@ -8150,28 +8150,28 @@ export class S3 extends S3Client { /** *

Passes transformed - * objects to a GetObject operation when using Object Lambda Access Points. For information about - * Object Lambda Access Points, see Transforming objects with - * Object Lambda Access Points in the Amazon S3 User Guide.

- *

This operation supports metadata that can be returned by GetObject, in addition to - * RequestRoute, RequestToken, StatusCode, - * ErrorCode, and ErrorMessage. The GetObject + * objects to a GetObject operation when using Object Lambda Access Points. For information about + * Object Lambda Access Points, see Transforming objects with + * Object Lambda Access Points in the Amazon S3 User Guide.

+ *

This operation supports metadata that can be returned by GetObject, in addition to + * RequestRoute, RequestToken, StatusCode, + * ErrorCode, and ErrorMessage. The GetObject * response metadata is supported so that the WriteGetObjectResponse caller, * typically an Lambda function, can provide the same metadata when it internally invokes - * GetObject. When WriteGetObjectResponse is called by a + * GetObject. When WriteGetObjectResponse is called by a * customer-owned Lambda function, the metadata returned to the end user - * GetObject call might differ from what Amazon S3 would normally return.

- *

You can include any number of metadata headers. When including a metadata header, it should be - * prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. - * The primary use case for this is to forward GetObject metadata.

- *

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact - * personally identifiable information (PII) and decompress S3 objects. These Lambda functions - * are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your - * Object Lambda Access Point.

- *

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

- *

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

- *

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

- *

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

+ * GetObject call might differ from what Amazon S3 would normally return.

+ *

You can include any number of metadata headers. When including a metadata header, it should be + * prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. + * The primary use case for this is to forward GetObject metadata.

+ *

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact + * personally identifiable information (PII) and decompress S3 objects. These Lambda functions + * are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your + * Object Lambda Access Point.

+ *

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

+ *

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

+ *

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

+ *

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

*/ public writeGetObjectResponse( args: WriteGetObjectResponseCommandInput, diff --git a/clients/client-s3/src/commands/AbortMultipartUploadCommand.ts b/clients/client-s3/src/commands/AbortMultipartUploadCommand.ts index 282c74f..b459c09 100644 --- a/clients/client-s3/src/commands/AbortMultipartUploadCommand.ts +++ b/clients/client-s3/src/commands/AbortMultipartUploadCommand.ts @@ -23,44 +23,44 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO /** *

This action 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 action and ensure that - * the parts list is empty.

- *

For information about permissions required to use the multipart upload, see Multipart Upload and - * Permissions.

- *

The following operations are related to AbortMultipartUpload:

- * + * 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 action and ensure that + * the parts list is empty.

+ *

For information about permissions required to use the multipart upload, see Multipart Upload and + * Permissions.

+ *

The following operations are related to AbortMultipartUpload:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts b/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts index 14b3285..9c00ec5 100644 --- a/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts +++ b/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts @@ -24,115 +24,115 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU /** *

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 - * action 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 action 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 and - * Permissions.

+ *

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 + * action 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 action 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 and + * Permissions.

* * - *

- * CompleteMultipartUpload 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

      - *
      • - *
    - *
    • - *
+ *

+ * CompleteMultipartUpload 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 CompleteMultipartUpload:

- * + *

The following operations are related to CompleteMultipartUpload:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/CopyObjectCommand.ts b/clients/client-s3/src/commands/CopyObjectCommand.ts index b8f7a46..1d00e8a 100644 --- a/clients/client-s3/src/commands/CopyObjectCommand.ts +++ b/clients/client-s3/src/commands/CopyObjectCommand.ts @@ -25,175 +25,175 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea /** *

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 action using this API. However, to copy - * 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.

- * - *

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.

- *

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 action 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.

- * - *

The copy request charge is based on the storage class and Region that you specify for - * the destination object. For pricing information, see Amazon S3 pricing.

- * - *

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, see Transfer Acceleration.

- * - *

- * Metadata - *

- *

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.

- *

To specify whether you want the object metadata copied from the source object or - * replaced with metadata provided in the request, you can optionally add the - * x-amz-metadata-directive header. When you grant permissions, you can use - * the s3:x-amz-metadata-directive condition key to enforce certain metadata - * behavior when objects are uploaded. For more information, see Specifying Conditions in a - * Policy in the Amazon S3 User Guide. For a complete list of - * Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for - * Amazon S3.

- *

- * - * x-amz-copy-source-if Headers - *

- *

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 - * following request parameters:

- *
    - *
  • - *

    - * x-amz-copy-source-if-match - *

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-none-match - *

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-unmodified-since - *

    - *
    • - *
  • - *

    - * x-amz-copy-source-if-modified-since - *

    - *
    • - *
- *

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

    - *
    • - *
+ * + *

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 action using this API. However, to copy + * 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.

+ * + *

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.

+ *

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 action 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.

+ * + *

The copy request charge is based on the storage class and Region that you specify for + * the destination object. For pricing information, see Amazon S3 pricing.

+ * + *

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, see Transfer Acceleration.

+ * + *

+ * Metadata + *

+ *

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.

+ *

To specify whether you want the object metadata copied from the source object or + * replaced with metadata provided in the request, you can optionally add the + * x-amz-metadata-directive header. When you grant permissions, you can use + * the s3:x-amz-metadata-directive condition key to enforce certain metadata + * behavior when objects are uploaded. For more information, see Specifying Conditions in a + * Policy in the Amazon S3 User Guide. For a complete list of + * Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for + * Amazon S3.

+ *

+ * + * x-amz-copy-source-if Headers + *

+ *

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 + * following request parameters:

+ *
    + *
  • + *

    + * x-amz-copy-source-if-match + *

    + *
    • + *
  • + *

    + * x-amz-copy-source-if-none-match + *

    + *
    • + *
  • + *

    + * x-amz-copy-source-if-unmodified-since + *

    + *
    • + *
  • + *

    + * x-amz-copy-source-if-modified-since + *

    + *
    • + *
+ *

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

    + *
    • + *
* - *

If both 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

    - *
    • - *
+ *

If both 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

    + *
    • + *
* - * - *

All headers with the x-amz- prefix, including - * x-amz-copy-source, must be signed.

- * - *

- * Server-side encryption - *

- *

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related - * headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys - * (SSE-S3 or SSE-KMS) or a customer-provided encryption key. 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. For more information about server-side encryption, see Using - * Server-Side Encryption.

- *

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more - * information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

- *

- * Access Control List (ACL)-Specific Request - * Headers - *

- *

When copying an object, you can optionally use headers to grant ACL-based permissions. - * By default, all objects are private. Only the owner has full access control. When adding a - * new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups - * defined by Amazon S3. These permissions are then added to the ACL on the object. For more - * information, see Access Control List (ACL) Overview and Managing ACLs Using the REST - * API.

+ * + *

All headers with the x-amz- prefix, including + * x-amz-copy-source, must be signed.

+ * + *

+ * Server-side encryption + *

+ *

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related + * headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys + * (SSE-S3 or SSE-KMS) or a customer-provided encryption key. 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. For more information about server-side encryption, see Using + * Server-Side Encryption.

+ *

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more + * information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

+ *

+ * Access Control List (ACL)-Specific Request + * Headers + *

+ *

When copying an object, you can optionally use headers to grant ACL-based permissions. + * By default, all objects are private. Only the owner has full access control. When adding a + * new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups + * defined by Amazon S3. These permissions are then added to the ACL on the object. For more + * information, see Access Control List (ACL) Overview and Managing ACLs Using the REST + * API.

* - *

- * Storage Class Options - *

- *

You can use the CopyObject action 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 in the Amazon S3 User Guide.

- *

- * 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 - * RestoreObject.

- *

The following operations are related to CopyObject:

- * - *

For more information, see Copying - * Objects.

+ *

+ * Storage Class Options + *

+ *

You can use the CopyObject action 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 in the Amazon S3 User Guide.

+ *

+ * 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 + * RestoreObject.

+ *

The following operations are related to CopyObject:

+ * + *

For more information, see Copying + * Objects.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/CreateBucketCommand.ts b/clients/client-s3/src/commands/CreateBucketCommand.ts index 7059de1..d1b0fcb 100644 --- a/clients/client-s3/src/commands/CreateBucketCommand.ts +++ b/clients/client-s3/src/commands/CreateBucketCommand.ts @@ -23,124 +23,124 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat /** *

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a - * valid Amazon Web Services 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 about bucket naming - * restrictions, see Bucket naming rules.

- *

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

- *

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 Europe (Ireland) - * Region. For more information, see Accessing a - * bucket.

- * - *

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:

    + * valid Amazon Web Services 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 about bucket naming + * restrictions, see Bucket naming rules.

    + *

    If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

    + *

    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 Europe (Ireland) + * Region. For more information, see Accessing a + * bucket.

    + * + *

    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:

      + *
        + *
      • + *

        + * id – if the value specified is the canonical user ID of an Amazon Web Services account

        + *
        • + *
      • + *

        + * uri – if you are granting permissions to a predefined + * group

        + *
        • + *
      • + *

        + * emailAddress – if the value specified is the email address of + * an Amazon Web Services account

        + * + *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        *
          *
        • - *

          - * id – if the value specified is the canonical user ID of an Amazon Web Services account

          + *

          US East (N. Virginia)

          *
          • *
        • - *

          - * uri – if you are granting permissions to a predefined - * group

          + *

          US West (N. California)

          *
          • *
        • - *

          - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

          - * - *

          Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

          - *
            - *
          • - *

            US East (N. Virginia)

            - *
            • - *
          • - *

            US West (N. California)

            - *
            • - *
          • - *

            US West (Oregon)

            - *
            • - *
          • - *

            Asia Pacific (Singapore)

            - *
            • - *
          • - *

            Asia Pacific (Sydney)

            - *
            • - *
          • - *

            Asia Pacific (Tokyo)

            - *
            • - *
          • - *

            Europe (Ireland)

            - *
            • - *
          • - *

            South America (São Paulo)

            - *
            • - *
          - *

          For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

          - *           + *

          US West (Oregon)

          + *
          • + *
        • + *

          Asia Pacific (Singapore)

          + *
          • + *
        • + *

          Asia Pacific (Sydney)

          + *
          • + *
        • + *

          Asia Pacific (Tokyo)

          + *
          • + *
        • + *

          Europe (Ireland)

          + *
          • + *
        • + *

          South America (São Paulo)

          *
          • *
        - *

        For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

        - *

        - * x-amz-grant-read: id="11112222333", id="444455556666" - *

        - *
        • - *
      - * - *

      You can use either a canned ACL or specify access permissions explicitly. You cannot - * do both.

      - *       + *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      + * + *
      • + *
    + *

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    + *

    + * x-amz-grant-read: id="11112222333", id="444455556666" + *

    + *
    • + *
+ * + *

You can use either a canned ACL or specify access permissions explicitly. You cannot + * do both.

+ * * - *

- * Permissions - *

- *

If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, - * authenticated-read, or if you specify access permissions explicitly through any other ACL, both - * s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the - * CreateBucket request is private, only s3:CreateBucket permission is needed.

- *

If ObjectLockEnabledForBucket is set to true in your CreateBucket request, - * s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

+ *

+ * Permissions + *

+ *

If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, + * authenticated-read, or if you specify access permissions explicitly through any other ACL, both + * s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the + * CreateBucket request is private, only s3:CreateBucket permission is needed.

+ *

If ObjectLockEnabledForBucket is set to true in your CreateBucket request, + * s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

* - *

The following operations are related to CreateBucket:

- * + *

The following operations are related to CreateBucket:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/CreateMultipartUploadCommand.ts b/clients/client-s3/src/commands/CreateMultipartUploadCommand.ts index b0bc68b..af0185a 100644 --- a/clients/client-s3/src/commands/CreateMultipartUploadCommand.ts +++ b/clients/client-s3/src/commands/CreateMultipartUploadCommand.ts @@ -24,266 +24,266 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa /** *

This action 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.

+ * 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.

+ *

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 - * action and Amazon S3 aborts the multipart upload. For more information, see Aborting - * Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

+ *

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 + * action 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 and - * Permissions.

+ *

For information about the permissions required to use the multipart upload API, see + * Multipart Upload 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 (Amazon Web Services Signature Version 4).

+ *

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 (Amazon Web Services 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.

- * + * + *

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 Amazon Web Services Key Management Service (Amazon Web Services - * 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 Amazon Web Services KMS CMK, the requester must - * have permission to the kms:Decrypt and kms:GenerateDataKey* - * 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. For more - * information, see Multipart upload API - * and permissions in the Amazon S3 User Guide.

+ *

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 Amazon Web Services Key Management Service (Amazon Web Services + * 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 Amazon Web Services KMS CMK, the requester must + * have permission to the kms:Decrypt and kms:GenerateDataKey* + * 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. For more + * information, see Multipart upload API + * and permissions in the Amazon S3 User Guide.

* - *

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account - * as the Amazon Web Services 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.

+ *

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account + * as the Amazon Web Services 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.

+ *

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 Amazon Web Services managed - * encryption keys or provide your own encryption key.

- *
    - *
  • - *

    Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored - * in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys - * used to encrypt data, specify the following headers in the request.

    + *
    + *
    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 Amazon Web Services managed + * encryption keys or provide your own encryption key.

    + *
      + *
    • + *

      Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored + * in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services 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 Amazon Web Services managed CMK in Amazon Web Services KMS to protect the data.

      + *       + * + *

      All GET and PUT requests for an object protected by Amazon Web Services 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 Amazon Web Services + * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services + * 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 Amazon Web Services + * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services + * 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 Amazon Web Services 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 Amazon Web Services 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:

      + *
        + *
      • + *

        + * id – if the value specified is the canonical user ID + * of an Amazon Web Services account

        + *
        • + *
      • + *

        + * uri – if you are granting permissions to a predefined + * group

        + *
        • + *
      • + *

        + * emailAddress – if the value specified is the email + * address of an Amazon Web Services account

        + * + *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        *
          *
        • - *

          x-amz-server-side-encryption

          + *

          US East (N. Virginia)

          *
          • *
        • - *

          x-amz-server-side-encryption-aws-kms-key-id

          + *

          US West (N. California)

          *
          • *
        • - *

          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 Amazon Web Services managed CMK in Amazon Web Services KMS to protect the data.

        - *         - * - *

        All GET and PUT requests for an object protected by Amazon Web Services 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 Amazon Web Services - * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services - * 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 Amazon Web Services - * KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services - * 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 Amazon Web Services 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 Amazon Web Services 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

        + *

        US West (Oregon)

        *
        • *
      • - *

        x-amz-grant-read-acp

        + *

        Asia Pacific (Singapore)

        *
        • *
      • - *

        x-amz-grant-write-acp

        + *

        Asia Pacific (Sydney)

        *
        • *
      • - *

        x-amz-grant-full-control

        - *
        • - *
      - *

      You specify each grantee as a type=value pair, where the type is one of - * the following:

      - *
        - *
      • - *

        - * id – if the value specified is the canonical user ID - * of an Amazon Web Services account

        + *

        Asia Pacific (Tokyo)

        *
        • *
      • - *

        - * uri – if you are granting permissions to a predefined - * group

        + *

        Europe (Ireland)

        *
        • *
      • - *

        - * emailAddress – if the value specified is the email - * address of an Amazon Web Services account

        - * - *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        - *
          - *
        • - *

          US East (N. Virginia)

          - *
          • - *
        • - *

          US West (N. California)

          - *
          • - *
        • - *

          US West (Oregon)

          - *
          • - *
        • - *

          Asia Pacific (Singapore)

          - *
          • - *
        • - *

          Asia Pacific (Sydney)

          - *
          • - *
        • - *

          Asia Pacific (Tokyo)

          - *
          • - *
        • - *

          Europe (Ireland)

          - *
          • - *
        • - *

          South America (São Paulo)

          - *
          • - *
        - *

        For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

        - *         + *

        South America (São Paulo)

        *
        • *
      - *

      For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

      - *

      - * x-amz-grant-read: id="11112222333", id="444455556666" - *

      - *
      • - *
    + *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    + * + *
    • + *
+ *

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

+ *

+ * x-amz-grant-read: id="11112222333", id="444455556666" + *

+ * + * * - *
- *
+ * + * * - *

The following operations are related to CreateMultipartUpload:

- * + *

The following operations are related to CreateMultipartUpload:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/src/commands/DeleteBucketAnalyticsConfigurationCommand.ts index 06397d8..2650b20 100644 --- a/clients/client-s3/src/commands/DeleteBucketAnalyticsConfigurationCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketAnalyticsConfigurationCommand.ts @@ -23,35 +23,35 @@ export interface DeleteBucketAnalyticsConfigurationCommandOutput extends __Metad /** *

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.

+ * 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.

+ *

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class + * Analysis.

* - *

The following operations are related to - * DeleteBucketAnalyticsConfiguration:

- * + *

The following operations are related to + * DeleteBucketAnalyticsConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketCommand.ts b/clients/client-s3/src/commands/DeleteBucketCommand.ts index bbaae96..d050be7 100644 --- a/clients/client-s3/src/commands/DeleteBucketCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketCommand.ts @@ -22,23 +22,23 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {} /** *

Deletes the S3 bucket. All objects (including all object versions and delete markers) in - * the bucket must be deleted before the bucket itself can be deleted.

+ * the bucket must be deleted before the bucket itself can be deleted.

* - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketCorsCommand.ts b/clients/client-s3/src/commands/DeleteBucketCorsCommand.ts index a435061..1e8e06f 100644 --- a/clients/client-s3/src/commands/DeleteBucketCorsCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketCorsCommand.ts @@ -23,27 +23,27 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {} /** *

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 S3 User Guide.

+ *

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 S3 User Guide.

* - *

- * Related Resources: - *

- * + *

+ * Related Resources: + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts b/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts index 892ab7b..17d789f 100644 --- a/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts @@ -23,29 +23,29 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {} /** *

This implementation of the DELETE action removes default encryption from the bucket. - * For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the - * Amazon S3 User 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 S3 User Guide.

+ * For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the + * Amazon S3 User 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 S3 User Guide.

* - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts b/clients/client-s3/src/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts index c21bd84..74cc0f4 100644 --- a/clients/client-s3/src/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts @@ -24,28 +24,28 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend /** *

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * DeleteBucketIntelligentTieringConfiguration include:

- * + *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * DeleteBucketIntelligentTieringConfiguration include:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts b/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts index 1a45f5c..3d1c677 100644 --- a/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts @@ -23,31 +23,31 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad /** *

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:

- * + * 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:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts b/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts index a9698f9..5cb8b1b 100644 --- a/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts @@ -23,31 +23,31 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {} /** *

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.

+ * 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.

+ *

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:

- * + *

For more information about the object expiration, see Elements to + * Describe Lifecycle Actions.

+ *

Related actions include:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketMetricsConfigurationCommand.ts b/clients/client-s3/src/commands/DeleteBucketMetricsConfigurationCommand.ts index 5e89dcc..1eb9a3c 100644 --- a/clients/client-s3/src/commands/DeleteBucketMetricsConfigurationCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketMetricsConfigurationCommand.ts @@ -23,41 +23,41 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat /** *

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.

+ * 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.

+ *

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:

- * + *

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

+ *

The following operations are related to + * DeleteBucketMetricsConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts b/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts index ef5282b..d43f74e 100644 --- a/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts @@ -23,24 +23,24 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe /** *

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:PutBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying - * Permissions in a Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to - * DeleteBucketOwnershipControls:

- * + * must have the s3:PutBucketOwnershipControls permission. For more information + * about Amazon S3 permissions, see Specifying + * Permissions in a Policy.

+ *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

+ *

The following operations are related to + * DeleteBucketOwnershipControls:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts b/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts index 8a95321..a73d076 100644 --- a/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts @@ -23,38 +23,38 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {} /** *

This implementation of the DELETE action 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 - * Amazon Web Services 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.

+ * policy of a specified bucket. If you are using an identity other than the root user of the + * Amazon Web Services 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.

+ *

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 Amazon Web Services 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.

- * + * + *

As a security precaution, the root user of the Amazon Web Services 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 - *

- * + *

For more information about bucket policies, see Using Bucket Policies and + * UserPolicies.

+ *

The following operations are related to DeleteBucketPolicy + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketReplicationCommand.ts b/clients/client-s3/src/commands/DeleteBucketReplicationCommand.ts index 099646a..df25dd6 100644 --- a/clients/client-s3/src/commands/DeleteBucketReplicationCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketReplicationCommand.ts @@ -23,31 +23,31 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer { /** *

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.

- * + *

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 User Guide.

+ *

For information about replication configuration, see Replication in the Amazon S3 User Guide.

* - *

The following operations are related to DeleteBucketReplication:

- * + *

The following operations are related to DeleteBucketReplication:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts b/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts index dd5ce24..3160342 100644 --- a/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts @@ -24,22 +24,22 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {} /** *

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:

- * + *

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:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts b/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts index 2fa43f4..e6d06f7 100644 --- a/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts @@ -23,32 +23,32 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {} /** *

This action 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.

+ * 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 action 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.

+ *

This DELETE action 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.

+ *

For more information about hosting websites, see Hosting Websites on Amazon S3.

* - *

The following operations are related to DeleteBucketWebsite:

- * + *

The following operations are related to DeleteBucketWebsite:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteObjectCommand.ts b/clients/client-s3/src/commands/DeleteObjectCommand.ts index 1e01498..85643d8 100644 --- a/clients/client-s3/src/commands/DeleteObjectCommand.ts +++ b/clients/client-s3/src/commands/DeleteObjectCommand.ts @@ -23,36 +23,36 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat /** *

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 but will still respond that the command was successful.

+ * which becomes the latest version of the object. If there isn't a null version, Amazon S3 does + * not remove any objects but will still respond that the command was successful.

* - *

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.

+ *

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.

+ *

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.

+ *

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 DELETE Object 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.

+ *

You can delete objects by explicitly calling DELETE Object 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 action is related to DeleteObject:

- * + *

The following action is related to DeleteObject:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts b/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts index 5f914e3..d26c8bf 100644 --- a/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts +++ b/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts @@ -23,30 +23,30 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut /** *

Removes the entire tag set from the specified object. For more information about - * managing object tags, see Object - * Tagging.

+ * managing object tags, see Object + * Tagging.

* - *

To use this operation, you must have permission to perform the - * s3:DeleteObjectTagging action.

+ *

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.

+ *

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:

- * + *

The following operations are related to + * DeleteBucketMetricsConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeleteObjectsCommand.ts b/clients/client-s3/src/commands/DeleteObjectsCommand.ts index b8b4efe..a74c517 100644 --- a/clients/client-s3/src/commands/DeleteObjectsCommand.ts +++ b/clients/client-s3/src/commands/DeleteObjectsCommand.ts @@ -24,62 +24,62 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad /** *

This action 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 action provides - * a suitable alternative to sending individual delete requests, reducing per-request - * overhead.

+ * request. If you know the object keys that you want to delete, then this action 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 action 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 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 action 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 action supports two modes for the response: verbose and quiet. By default, the - * action 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 - * action encountered an error. For a successful deletion, the action does not return - * any information about the delete in the response body.

+ *

The action supports two modes for the response: verbose and quiet. By default, the + * action 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 + * action encountered an error. For a successful deletion, the action does not return + * any information about the delete in the response body.

* - *

When performing this action 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.

+ *

When performing this action 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.

+ *

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:

- * + *

The following operations are related to DeleteObjects:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/DeletePublicAccessBlockCommand.ts b/clients/client-s3/src/commands/DeletePublicAccessBlockCommand.ts index 8374ab3..191a623 100644 --- a/clients/client-s3/src/commands/DeletePublicAccessBlockCommand.ts +++ b/clients/client-s3/src/commands/DeletePublicAccessBlockCommand.ts @@ -23,34 +23,34 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer { /** *

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.

+ * 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 DeletePublicAccessBlock:

- * + *

The following operations are related to DeletePublicAccessBlock:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts index b98d1ac..217f58a 100644 --- a/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts @@ -25,32 +25,32 @@ export interface GetBucketAccelerateConfigurationCommandOutput /** *

This implementation of the GET action 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 S3 User 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.

+ * 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 S3 User 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 S3 User Guide.

- *

- * Related Resources - *

- * + *

For more information about transfer acceleration, see Transfer Acceleration in the + * Amazon S3 User Guide.

+ *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketAclCommand.ts b/clients/client-s3/src/commands/GetBucketAclCommand.ts index 7ac8902..0af65a8 100644 --- a/clients/client-s3/src/commands/GetBucketAclCommand.ts +++ b/clients/client-s3/src/commands/GetBucketAclCommand.ts @@ -23,21 +23,21 @@ export interface GetBucketAclCommandOutput extends GetBucketAclOutput, __Metadat /** *

This implementation of the GET action 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.

+ * 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 - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts index 718fe39..f777aea 100644 --- a/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts @@ -25,35 +25,35 @@ export interface GetBucketAnalyticsConfigurationCommandOutput /** *

This implementation of the GET action 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 S3 User Guide.

- *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis in the Amazon S3 User Guide.

+ * 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 S3 User Guide.

+ *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class + * Analysis in the Amazon S3 User Guide.

* - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketCorsCommand.ts b/clients/client-s3/src/commands/GetBucketCorsCommand.ts index 76f9c22..d050271 100644 --- a/clients/client-s3/src/commands/GetBucketCorsCommand.ts +++ b/clients/client-s3/src/commands/GetBucketCorsCommand.ts @@ -24,25 +24,25 @@ export interface GetBucketCorsCommandOutput extends GetBucketCorsOutput, __Metad /** *

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.

+ *

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.

+ *

For more information about cors, see Enabling + * Cross-Origin Resource Sharing.

* - *

The following operations are related to GetBucketCors:

- * + *

The following operations are related to GetBucketCors:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts b/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts index 5a3db43..0f9c83b 100644 --- a/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts +++ b/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts @@ -23,27 +23,27 @@ export interface GetBucketEncryptionCommandOutput extends GetBucketEncryptionOut /** *

Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not - * have a default encryption configuration, GetBucketEncryption returns - * ServerSideEncryptionConfigurationNotFoundError.

- *

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:

- * + * have a default encryption configuration, GetBucketEncryption returns + * ServerSideEncryptionConfigurationNotFoundError.

+ *

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:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketIntelligentTieringConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketIntelligentTieringConfigurationCommand.ts index 8915e86..a36a58a 100644 --- a/clients/client-s3/src/commands/GetBucketIntelligentTieringConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketIntelligentTieringConfigurationCommand.ts @@ -29,28 +29,28 @@ export interface GetBucketIntelligentTieringConfigurationCommandOutput /** *

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * GetBucketIntelligentTieringConfiguration include:

- * + *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * GetBucketIntelligentTieringConfiguration include:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts index 8d47fce..f667d85 100644 --- a/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts @@ -25,35 +25,35 @@ export interface GetBucketInventoryConfigurationCommandOutput /** *

Returns an inventory configuration (identified by the inventory configuration ID) from - * the bucket.

+ * 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.

+ *

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.

+ *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

* - *

The following operations are related to - * GetBucketInventoryConfiguration:

- * + *

The following operations are related to + * GetBucketInventoryConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts index 7a6bc40..d042c93 100644 --- a/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts @@ -25,61 +25,61 @@ export interface GetBucketLifecycleConfigurationCommandOutput /** * - *

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 using a previous version of the lifecycle configuration, it still - * works. For the earlier action, see GetBucketLifecycle.

- * - *

Returns the lifecycle configuration information set on the bucket. For information about - * lifecycle configuration, see Object - * Lifecycle Management.

+ *

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 using a previous version of the lifecycle configuration, it still + * works. For the earlier action, 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.

+ *

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 - * GetBucketLifecycleConfiguration:

- * + *

+ * 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 + * GetBucketLifecycleConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketLocationCommand.ts b/clients/client-s3/src/commands/GetBucketLocationCommand.ts index c39951d..d012b58 100644 --- a/clients/client-s3/src/commands/GetBucketLocationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketLocationCommand.ts @@ -23,26 +23,26 @@ export interface GetBucketLocationCommandOutput extends GetBucketLocationOutput, /** *

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.

+ * 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.

+ *

To use this implementation of the operation, you must be the bucket owner.

* - *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

+ *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

* - *

The following operations are related to GetBucketLocation:

- * + *

The following operations are related to GetBucketLocation:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketLoggingCommand.ts b/clients/client-s3/src/commands/GetBucketLoggingCommand.ts index 4971396..2abccfc 100644 --- a/clients/client-s3/src/commands/GetBucketLoggingCommand.ts +++ b/clients/client-s3/src/commands/GetBucketLoggingCommand.ts @@ -23,21 +23,21 @@ export interface GetBucketLoggingCommandOutput extends GetBucketLoggingOutput, _ /** *

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.

+ * that status. To use GET, you must be the bucket owner.

* - *

The following operations are related to GetBucketLogging:

- * + *

The following operations are related to GetBucketLogging:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts index 5d7b49e..dcb45b0 100644 --- a/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts @@ -25,42 +25,42 @@ export interface GetBucketMetricsConfigurationCommandOutput /** *

Gets a metrics configuration (specified by the metrics configuration ID) from the - * bucket. Note that this doesn't include the daily storage metrics.

+ * 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.

+ *

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.

+ *

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon + * CloudWatch.

* - *

The following operations are related to - * GetBucketMetricsConfiguration:

- * + *

The following operations are related to + * GetBucketMetricsConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts index 913a858..ac8e6dc 100644 --- a/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts @@ -23,26 +23,26 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific /** *

Returns the notification configuration of a bucket.

- *

If notifications are not enabled on the bucket, the action returns an empty - * NotificationConfiguration element.

+ *

If notifications are not enabled on the bucket, the action 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.

+ *

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.

+ *

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 action is related to GetBucketNotification:

- * + *

The following action is related to GetBucketNotification:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts b/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts index 7deffb6..e6e98f3 100644 --- a/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts +++ b/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts @@ -23,23 +23,23 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners /** *

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:GetBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying - * Permissions in a Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to GetBucketOwnershipControls:

- * + * must have the s3:GetBucketOwnershipControls permission. For more information + * about Amazon S3 permissions, see Specifying + * Permissions in a Policy.

+ *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

+ *

The following operations are related to GetBucketOwnershipControls:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketPolicyCommand.ts b/clients/client-s3/src/commands/GetBucketPolicyCommand.ts index 5259b71..de50924 100644 --- a/clients/client-s3/src/commands/GetBucketPolicyCommand.ts +++ b/clients/client-s3/src/commands/GetBucketPolicyCommand.ts @@ -23,32 +23,32 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M /** *

Returns the policy of a specified bucket. If you are using an identity other than the - * root user of the Amazon Web Services 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.

+ * root user of the Amazon Web Services 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.

+ *

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 Amazon Web Services 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.

- * + * + *

As a security precaution, the root user of the Amazon Web Services 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.

+ *

For more information about bucket policies, see Using Bucket Policies and User + * Policies.

* - *

The following action is related to GetBucketPolicy:

- * + *

The following action is related to GetBucketPolicy:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketPolicyStatusCommand.ts b/clients/client-s3/src/commands/GetBucketPolicyStatusCommand.ts index 8da1a47..017f50a 100644 --- a/clients/client-s3/src/commands/GetBucketPolicyStatusCommand.ts +++ b/clients/client-s3/src/commands/GetBucketPolicyStatusCommand.ts @@ -23,36 +23,36 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu /** *

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.

+ * 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".

+ *

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

* - *

The following operations are related to GetBucketPolicyStatus:

- * + *

The following operations are related to GetBucketPolicyStatus:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketReplicationCommand.ts b/clients/client-s3/src/commands/GetBucketReplicationCommand.ts index 16ceb6c..fb4696a 100644 --- a/clients/client-s3/src/commands/GetBucketReplicationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketReplicationCommand.ts @@ -23,40 +23,40 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO /** *

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 S3 User Guide.

+ * + *

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 S3 User Guide.

* - *

This action requires permissions for the s3:GetReplicationConfiguration - * action. For more information about permissions, see Using Bucket Policies and User - * Policies.

+ *

This action 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.

+ *

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 List of - * replication-related error codes - *

+ *

For information about GetBucketReplication errors, see List of + * replication-related error codes + *

* * - *

The following operations are related to GetBucketReplication:

- * + *

The following operations are related to GetBucketReplication:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketRequestPaymentCommand.ts b/clients/client-s3/src/commands/GetBucketRequestPaymentCommand.ts index 22f1bf8..a8039e8 100644 --- a/clients/client-s3/src/commands/GetBucketRequestPaymentCommand.ts +++ b/clients/client-s3/src/commands/GetBucketRequestPaymentCommand.ts @@ -23,16 +23,16 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa /** *

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.

+ * operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

* - *

The following operations are related to GetBucketRequestPayment:

- * + *

The following operations are related to GetBucketRequestPayment:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketTaggingCommand.ts b/clients/client-s3/src/commands/GetBucketTaggingCommand.ts index ad76aa2..6489c4e 100644 --- a/clients/client-s3/src/commands/GetBucketTaggingCommand.ts +++ b/clients/client-s3/src/commands/GetBucketTaggingCommand.ts @@ -23,37 +23,37 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _ /** *

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.

+ *

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.

      - *
      • - *
    - *
    • - *
+ *

+ * 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:

- * + *

The following operations are related to GetBucketTagging:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketVersioningCommand.ts b/clients/client-s3/src/commands/GetBucketVersioningCommand.ts index 5553baa..fffd1e0 100644 --- a/clients/client-s3/src/commands/GetBucketVersioningCommand.ts +++ b/clients/client-s3/src/commands/GetBucketVersioningCommand.ts @@ -23,30 +23,30 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut /** *

Returns the versioning state of a bucket.

- *

To retrieve the versioning state of a bucket, you must be the bucket owner.

+ *

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.

+ *

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:

- * + *

The following operations are related to GetBucketVersioning:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetBucketWebsiteCommand.ts b/clients/client-s3/src/commands/GetBucketWebsiteCommand.ts index 6dcde60..448b741 100644 --- a/clients/client-s3/src/commands/GetBucketWebsiteCommand.ts +++ b/clients/client-s3/src/commands/GetBucketWebsiteCommand.ts @@ -23,26 +23,26 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _ /** *

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 action 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:

- * + * configure a bucket as website by adding a website configuration. For more information about + * hosting websites, see Hosting Websites on + * Amazon S3.

+ *

This GET action 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:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetObjectAclCommand.ts b/clients/client-s3/src/commands/GetObjectAclCommand.ts index 6dcdf5f..62780e6 100644 --- a/clients/client-s3/src/commands/GetObjectAclCommand.ts +++ b/clients/client-s3/src/commands/GetObjectAclCommand.ts @@ -23,32 +23,32 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat /** *

Returns the access control list (ACL) of an object. To use this operation, you must have - * READ_ACP access to the object.

- *

This action is not supported by Amazon S3 on Outposts.

- *

- * 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.

+ * READ_ACP access to the object.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

+ * 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:

- * + *

The following operations are related to GetObjectAcl:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetObjectCommand.ts b/clients/client-s3/src/commands/GetObjectCommand.ts index 4facdaa..4320c5b 100644 --- a/clients/client-s3/src/commands/GetObjectCommand.ts +++ b/clients/client-s3/src/commands/GetObjectCommand.ts @@ -21,186 +21,186 @@ export interface GetObjectCommandOutput extends GetObjectOutput, __MetadataBeare /** *

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.

+ * 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.

+ *

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 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.

+ *

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 S3 Glacier or - * S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or - * S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a - * copy using RestoreObject. Otherwise, this action returns an - * InvalidObjectStateError error. For information about restoring archived - * objects, see Restoring Archived - * Objects.

+ *

If the object you are retrieving is stored in the S3 Glacier or + * S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or + * S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a + * copy using RestoreObject. Otherwise, this action 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 Amazon Web Services - * 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).

+ *

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 Amazon Web Services + * 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 the relevant permission to read object tags, 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.

+ *

Assuming you have the relevant permission to read object tags, 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 relevant read object (or version) 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.

    - *
    • - *
+ *

+ * Permissions + *

+ *

You need the relevant read object (or version) 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 action returns the current version of an object. To return a - * different version, use the versionId subresource.

+ *

+ * Versioning + *

+ *

By default, the GET action returns the current version of an object. To return a + * different version, use the versionId subresource.

* - * - *
    - *
  • - *

    You need the s3:GetObjectVersion permission to access a specific version of an object. - *

    - *
    • - *
  • - *

    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.

    - *
    • - *
- * + * + *
    + *
  • + *

    You need the s3:GetObjectVersion permission to access a specific version of an object. + *

    + *
    • + *
  • + *

    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.

+ *

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.

+ *

+ * 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 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 - *

    - *
    • - *
+ * + *

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 - *

+ *

+ * 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-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.

+ *

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.

+ *

For more information about conditional requests, see RFC 7232.

* - *

The following operations are related to GetObject:

- * + *

The following operations are related to GetObject:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts b/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts index 4596075..7e0958d 100644 --- a/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts +++ b/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts @@ -23,7 +23,7 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu /** *

Gets an object's current Legal Hold status. For more information, see Locking Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts b/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts index 41a377b..4001c81 100644 --- a/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts @@ -23,9 +23,9 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo /** *

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.

+ * configuration will be applied by default to every new object placed in the specified + * bucket. For more information, see Locking + * Objects.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetObjectRetentionCommand.ts b/clients/client-s3/src/commands/GetObjectRetentionCommand.ts index fbb348c..d3a33cd 100644 --- a/clients/client-s3/src/commands/GetObjectRetentionCommand.ts +++ b/clients/client-s3/src/commands/GetObjectRetentionCommand.ts @@ -23,7 +23,7 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu /** *

Retrieves an object's retention settings. For more information, see Locking Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetObjectTaggingCommand.ts b/clients/client-s3/src/commands/GetObjectTaggingCommand.ts index c5c7096..e978f4e 100644 --- a/clients/client-s3/src/commands/GetObjectTaggingCommand.ts +++ b/clients/client-s3/src/commands/GetObjectTaggingCommand.ts @@ -23,33 +23,33 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _ /** *

Returns the tag-set of an object. You send the GET request against the tagging - * subresource associated with the object.

+ * subresource associated with the object.

* - *

To use this operation, you must have permission to perform the - * s3:GetObjectTagging action. By default, the GET action 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.

+ *

To use this operation, you must have permission to perform the + * s3:GetObjectTagging action. By default, the GET action 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.

+ *

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.

+ *

For information about the Amazon S3 object tagging feature, see Object Tagging.

* - *

The following action is related to GetObjectTagging:

- * + *

The following action is related to GetObjectTagging:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetObjectTorrentCommand.ts b/clients/client-s3/src/commands/GetObjectTorrentCommand.ts index c2ab63b..609022e 100644 --- a/clients/client-s3/src/commands/GetObjectTorrentCommand.ts +++ b/clients/client-s3/src/commands/GetObjectTorrentCommand.ts @@ -23,22 +23,22 @@ export interface GetObjectTorrentCommandOutput extends GetObjectTorrentOutput, _ /** *

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - * distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

- * - *

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 a customer-provided encryption - * key.

- * - *

To use GET, you must have READ access to the object.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectTorrent:

- * + * distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

+ * + *

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 a customer-provided encryption + * key.

+ * + *

To use GET, you must have READ access to the object.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

The following action is related to GetObjectTorrent:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts b/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts index db00115..0037e47 100644 --- a/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts +++ b/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts @@ -23,45 +23,45 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO /** *

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.

+ * 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.

- * + * + *

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".

+ *

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:

- * + *

The following operations are related to GetPublicAccessBlock:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/HeadBucketCommand.ts b/clients/client-s3/src/commands/HeadBucketCommand.ts index 6d5ad75..05b65f4 100644 --- a/clients/client-s3/src/commands/HeadBucketCommand.ts +++ b/clients/client-s3/src/commands/HeadBucketCommand.ts @@ -23,21 +23,21 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {} /** *

This action is useful to determine if a bucket exists and you have permission to - * access it. The action returns a 200 OK if the bucket exists and you have - * permission to access it.

+ * access it. The action returns a 200 OK if the bucket exists and you have + * permission to access it.

* * - *

If the bucket does not exist or you do not have permission to access it, the HEAD request - * returns a generic 404 Not Found or 403 Forbidden code. A message body is not - * included, so you cannot determine the exception beyond these error codes.

+ *

If the bucket does not exist or you do not have permission to access it, the HEAD request + * returns a generic 404 Not Found or 403 Forbidden code. A message body is not + * included, so you cannot determine the exception beyond these error codes.

* - *

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.

+ *

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.

* * - *

To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.

+ *

To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/HeadObjectCommand.ts b/clients/client-s3/src/commands/HeadObjectCommand.ts index e2d5257..fa350fa 100644 --- a/clients/client-s3/src/commands/HeadObjectCommand.ts +++ b/clients/client-s3/src/commands/HeadObjectCommand.ts @@ -24,117 +24,117 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea /** *

The HEAD action retrieves metadata from an object without returning the object - * itself. This action is useful if you're only interested in an object's metadata. To use - * HEAD, you must have READ access to the object.

+ * itself. This action 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 action on an - * object. The response is identical to the GET response except that there is no - * response body. Because of this, if the HEAD request generates an error, it - * returns a generic 404 Not Found or 403 Forbidden code. It is not - * possible to retrieve the exact exception beyond these error codes.

+ *

A HEAD request has the same options as a GET action on an + * object. The response is identical to the GET response except that there is no + * response body. Because of this, if the HEAD request generates an error, it + * returns a generic 404 Not Found or 403 Forbidden code. It is not + * possible to retrieve the exact exception beyond these error codes.

* - *

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 Amazon Web Services 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.

    - *
    • - *
  • - *

    - * The last modified property in this case is the creation date of the object.

    - *
    • - *
- * + *

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 Amazon Web Services 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.

    + *
    • + *
  • + *

    + * The last modified property in this case is the creation date of the object.

    + *
    • + *
+ * * * - *

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.

    - *
    • - *
+ *

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.

+ *

For more information about conditional requests, see RFC 7232.

* - *

- * Permissions - *

- *

You need the relevant read object (or version) 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.

    - *
    • - *
+ *

+ * Permissions + *

+ *

You need the relevant read object (or version) 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 action is related to HeadObject:

- * + *

The following action is related to HeadObject:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListBucketAnalyticsConfigurationsCommand.ts b/clients/client-s3/src/commands/ListBucketAnalyticsConfigurationsCommand.ts index f47ed66..b7b109f 100644 --- a/clients/client-s3/src/commands/ListBucketAnalyticsConfigurationsCommand.ts +++ b/clients/client-s3/src/commands/ListBucketAnalyticsConfigurationsCommand.ts @@ -25,45 +25,45 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput /** *

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - * configurations per bucket.

+ * configurations per bucket.

* - *

This action 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.

+ *

This action 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.

+ *

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.

+ *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class + * Analysis.

* - *

The following operations are related to - * ListBucketAnalyticsConfigurations:

- * + *

The following operations are related to + * ListBucketAnalyticsConfigurations:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts b/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts index 380933a..1f54bde 100644 --- a/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts +++ b/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts @@ -29,28 +29,28 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput /** *

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * ListBucketIntelligentTieringConfigurations include:

- * + *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * ListBucketIntelligentTieringConfigurations include:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts b/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts index e9e50e4..14f0b3a 100644 --- a/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts +++ b/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts @@ -25,44 +25,44 @@ export interface ListBucketInventoryConfigurationsCommandOutput /** *

Returns a list of inventory configurations for the bucket. You can have up to 1,000 - * analytics configurations per bucket.

+ * analytics configurations per bucket.

* - *

This action 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.

+ *

This action 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.

+ *

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 - *

+ *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory + *

* - *

The following operations are related to - * ListBucketInventoryConfigurations:

- * + *

The following operations are related to + * ListBucketInventoryConfigurations:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts b/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts index 476b676..76befdd 100644 --- a/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts +++ b/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts @@ -25,46 +25,46 @@ export interface ListBucketMetricsConfigurationsCommandOutput /** *

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.

+ * 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 action 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.

+ *

This action 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.

+ *

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.

+ *

For more information about metrics configurations and CloudWatch request metrics, see + * Monitoring Metrics with Amazon + * CloudWatch.

* - *

The following operations are related to - * ListBucketMetricsConfigurations:

- * + *

The following operations are related to + * ListBucketMetricsConfigurations:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListMultipartUploadsCommand.ts b/clients/client-s3/src/commands/ListMultipartUploadsCommand.ts index ab356a6..56a8120 100644 --- a/clients/client-s3/src/commands/ListMultipartUploadsCommand.ts +++ b/clients/client-s3/src/commands/ListMultipartUploadsCommand.ts @@ -23,56 +23,56 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO /** *

This action 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.

+ * multipart upload that has been initiated using the Initiate Multipart Upload request, but + * has not yet been completed or aborted.

* - *

This action 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.

+ *

This action 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.

+ *

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 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 and - * Permissions.

+ *

For information on permissions required to use the multipart upload API, see Multipart Upload and + * Permissions.

* - *

The following operations are related to ListMultipartUploads:

- * + *

The following operations are related to ListMultipartUploads:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListObjectVersionsCommand.ts b/clients/client-s3/src/commands/ListObjectVersionsCommand.ts index d174552..1434f00 100644 --- a/clients/client-s3/src/commands/ListObjectVersionsCommand.ts +++ b/clients/client-s3/src/commands/ListObjectVersionsCommand.ts @@ -23,44 +23,44 @@ export interface ListObjectVersionsCommandOutput extends ListObjectVersionsOutpu /** *

Returns metadata about all versions of the objects in a bucket. You can also use request - * parameters as selection criteria to return metadata about a subset of all the object - * versions.

- * - *

- * To use this operation, you must have permissions to perform the - * s3:ListBucketVersions action. Be aware of the name difference. - *

- * - * - *

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.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following operations are related to - * ListObjectVersions:

- * + * parameters as selection criteria to return metadata about a subset of all the object + * versions.

+ * + *

+ * To use this operation, you must have permissions to perform the + * s3:ListBucketVersions action. Be aware of the name difference. + *

+ * + * + *

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.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

The following operations are related to + * ListObjectVersions:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListObjectsCommand.ts b/clients/client-s3/src/commands/ListObjectsCommand.ts index 784220f..0a3da75 100644 --- a/clients/client-s3/src/commands/ListObjectsCommand.ts +++ b/clients/client-s3/src/commands/ListObjectsCommand.ts @@ -23,43 +23,43 @@ export interface ListObjectsCommandOutput extends ListObjectsOutput, __MetadataB /** *

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 action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, - * Amazon S3 continues to support ListObjects.

- * + * 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 action 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:

- * + *

The following operations are related to ListObjects:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListObjectsV2Command.ts b/clients/client-s3/src/commands/ListObjectsV2Command.ts index 00277b0..9c40cea 100644 --- a/clients/client-s3/src/commands/ListObjectsV2Command.ts +++ b/clients/client-s3/src/commands/ListObjectsV2Command.ts @@ -23,47 +23,47 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad /** *

Returns some or all (up to 1,000) of the objects in a bucket with each request. 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. - * Objects are returned sorted in an ascending order of the respective key names in the list. - * For more information about listing objects, see Listing object keys - * programmatically - *

+ * 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. + * Objects are returned sorted in an ascending order of the respective key names in the list. + * For more information about listing objects, see Listing object keys + * programmatically + *

* - *

To use this operation, you must have READ access to the bucket.

+ *

To use this operation, you must have READ access to the bucket.

* - *

To use this action in an 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 this action. 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 use this action in an 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 this action. 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.

+ *

To get a list of your buckets, see ListBuckets.

* - *

The following operations are related to ListObjectsV2:

- * + *

The following operations are related to ListObjectsV2:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/ListPartsCommand.ts b/clients/client-s3/src/commands/ListPartsCommand.ts index 68905af..6d3a8b1 100644 --- a/clients/client-s3/src/commands/ListPartsCommand.ts +++ b/clients/client-s3/src/commands/ListPartsCommand.ts @@ -20,50 +20,50 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare /** *

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.

+ * 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 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 and - * Permissions.

+ *

For information on permissions required to use the multipart upload API, see Multipart Upload and + * Permissions.

* - *

The following operations are related to ListParts:

- * + *

The following operations are related to ListParts:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts index 8d26e2a..ef0416a 100644 --- a/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts @@ -23,51 +23,51 @@ export interface PutBucketAccelerateConfigurationCommandOutput extends __Metadat /** *

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.

+ * 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.

+ *

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 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 action returns the transfer acceleration - * state of a bucket.

+ *

The GetBucketAccelerateConfiguration action 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.

+ *

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 (".").

+ *

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.

+ *

For more information about transfer acceleration, see Transfer Acceleration.

* - *

The following operations are related to - * PutBucketAccelerateConfiguration:

- * + *

The following operations are related to + * PutBucketAccelerateConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketAclCommand.ts b/clients/client-s3/src/commands/PutBucketAclCommand.ts index 73236b2..5857227 100644 --- a/clients/client-s3/src/commands/PutBucketAclCommand.ts +++ b/clients/client-s3/src/commands/PutBucketAclCommand.ts @@ -24,195 +24,195 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {} /** *

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.

+ * 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 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.

- * + * + *

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.

+ *

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 (Amazon Web Services 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:

    + *

    + * 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 (Amazon Web Services 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:

      + *
        + *
      • + *

        + * id – if the value specified is the canonical user ID of an Amazon Web Services account

        + *
        • + *
      • + *

        + * uri – if you are granting permissions to a predefined + * group

        + *
        • + *
      • + *

        + * emailAddress – if the value specified is the email address of + * an Amazon Web Services account

        + * + *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        *
          *
        • - *

          - * id – if the value specified is the canonical user ID of an Amazon Web Services account

          + *

          US East (N. Virginia)

          + *
          • + *
        • + *

          US West (N. California)

          + *
          • + *
        • + *

          US West (Oregon)

          + *
          • + *
        • + *

          Asia Pacific (Singapore)

          *
          • *
        • - *

          - * uri – if you are granting permissions to a predefined - * group

          + *

          Asia Pacific (Sydney)

          *
          • *
        • - *

          - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

          - * - *

          Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

          - *
            - *
          • - *

            US East (N. Virginia)

            - *
            • - *
          • - *

            US West (N. California)

            - *
            • - *
          • - *

            US West (Oregon)

            - *
            • - *
          • - *

            Asia Pacific (Singapore)

            - *
            • - *
          • - *

            Asia Pacific (Sydney)

            - *
            • - *
          • - *

            Asia Pacific (Tokyo)

            - *
            • - *
          • - *

            Europe (Ireland)

            - *
            • - *
          • - *

            South America (São Paulo)

            - *
            • - *
          - *

          For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

          - *           + *

          Asia Pacific (Tokyo)

          + *
          • + *
        • + *

          Europe (Ireland)

          + *
          • + *
        • + *

          South America (São Paulo)

          *
          • *
        - *

        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 Amazon Web Services accounts identified by their email addresses.

        - *

        - * x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", - * id="111122223333", id="555566667777" - *

        + *

        For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

        + *         + *
        • + *
      + *

      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 Amazon Web Services accounts identified by their email addresses.

      + *

      + * x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", + * id="111122223333", id="555566667777" + *

      * - *
      • - *
    - *

    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:

    + *
    • + *
+ *

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 the person's ID:

    + *

    + * <>ID<><>GranteesEmail<> + * + *

    + *

    DisplayName is optional and ignored in the request

    + *
    • + *
  • + *

    By URI:

    + *

    + * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> + *

    + *
    • + *
  • + *

    By Email address:

    + *

    + * <>Grantees@email.com<>lt;/Grantee> + *

    + *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object + * acl request, appears as the CanonicalUser.

    + * + *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    *
      *
    • - *

      By the person's ID:

      - *

      - * <>ID<><>GranteesEmail<> - * - *

      - *

      DisplayName is optional and ignored in the request

      + *

      US East (N. Virginia)

      *
      • *
    • - *

      By URI:

      - *

      - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

      + *

      US West (N. California)

      *
      • *
    • - *

      By Email address:

      - *

      - * <>Grantees@email.com<>lt;/Grantee> - *

      - *

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       + *

      US West (Oregon)

      + *
      • + *
    • + *

      Asia Pacific (Singapore)

      *
      • - *
    - * - * - *

    - * Related Resources - *

    - *
      *
    • - *

      - * CreateBucket - *

      + *

      Asia Pacific (Sydney)

      *
      • *
    • - *

      - * DeleteBucket - *

      + *

      Asia Pacific (Tokyo)

      *
      • *
    • - *

      - * GetObjectAcl - *

      + *

      Europe (Ireland)

      + *
      • + *
    • + *

      South America (São Paulo)

      *
      • *
    + *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    + *     + *
    • + *
+ * + * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts index 93428b5..285112e 100644 --- a/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts @@ -23,121 +23,121 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata /** *

Sets an analytics configuration for the bucket (specified by the analytics configuration - * ID). You can have up to 1,000 analytics configurations per bucket.

+ * 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 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.

- * + * + *

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.

+ *

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. - *

      - *
      • - *
    - *
    • - *
+ *

+ * 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 - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketCorsCommand.ts b/clients/client-s3/src/commands/PutBucketCorsCommand.ts index 2162ec1..ef80c00 100644 --- a/clients/client-s3/src/commands/PutBucketCorsCommand.ts +++ b/clients/client-s3/src/commands/PutBucketCorsCommand.ts @@ -24,62 +24,62 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {} /** *

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 S3 User Guide.

+ * 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 S3 User Guide.

* - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketEncryptionCommand.ts b/clients/client-s3/src/commands/PutBucketEncryptionCommand.ts index 0ae453b..d814ad0 100644 --- a/clients/client-s3/src/commands/PutBucketEncryptionCommand.ts +++ b/clients/client-s3/src/commands/PutBucketEncryptionCommand.ts @@ -24,38 +24,38 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {} /** *

This action uses the encryption subresource to configure default - * encryption and Amazon S3 Bucket Key for an existing bucket.

- *

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys - * (SSE-S3) or Amazon Web Services KMS customer master keys (SSE-KMS). If you specify default encryption - * using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default - * encryption, see Amazon S3 default bucket encryption - * in the Amazon S3 User Guide. For more information about S3 Bucket Keys, - * see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

- * - *

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services 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 S3 User Guide.

+ * encryption and Amazon S3 Bucket Key for an existing bucket.

+ *

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys + * (SSE-S3) or Amazon Web Services KMS customer master keys (SSE-KMS). If you specify default encryption + * using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default + * encryption, see Amazon S3 default bucket encryption + * in the Amazon S3 User Guide. For more information about S3 Bucket Keys, + * see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

+ * + *

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services 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 S3 User Guide.

* - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketIntelligentTieringConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketIntelligentTieringConfigurationCommand.ts index 6140197..1fecdc8 100644 --- a/clients/client-s3/src/commands/PutBucketIntelligentTieringConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketIntelligentTieringConfigurationCommand.ts @@ -25,87 +25,87 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _ /** *

Puts a S3 Intelligent-Tiering configuration to the specified bucket. * You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

- *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

- *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to - * PutBucketIntelligentTieringConfiguration include:

- * - * - *

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically - * move objects stored in the S3 Intelligent-Tiering storage class to the - * Archive Access or Deep Archive Access tier.

- * + *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

+ *

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

+ *

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

+ *

Operations related to + * PutBucketIntelligentTieringConfiguration include:

+ * + * + *

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically + * move objects stored in the S3 Intelligent-Tiering storage class to the + * Archive Access or Deep Archive Access tier.

+ * * - *

- * 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:PutIntelligentTieringConfiguration bucket - * permission to set the configuration on the bucket.

      - *
      • - *
    - *
    • - *
+ *

+ * 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:PutIntelligentTieringConfiguration bucket + * permission to set the configuration on the bucket.

      + *
      • + *
    + *
    • + *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts index 426462c..9aae8c5 100644 --- a/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts @@ -23,106 +23,106 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata /** *

This implementation of the PUT action 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 Amazon Web Services 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 S3 User 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 S3 User Guide.

+ * (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 Amazon Web Services 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 S3 User 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 S3 User 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.

      - *
      • - *
    - *
    • - *
+ *

+ * 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 - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts index 8bed6ed..f1b04d9 100644 --- a/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts @@ -24,99 +24,99 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata /** *

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - * configuration. For information about lifecycle configuration, see Managing your storage - * lifecycle.

- * - * - *

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 Amazon Web Services 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:

- * + * configuration. For information about lifecycle configuration, see Managing your storage + * lifecycle.

+ * + * + *

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 Amazon Web Services 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:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketLoggingCommand.ts b/clients/client-s3/src/commands/PutBucketLoggingCommand.ts index 902f3e6..e66c05a 100644 --- a/clients/client-s3/src/commands/PutBucketLoggingCommand.ts +++ b/clients/client-s3/src/commands/PutBucketLoggingCommand.ts @@ -24,85 +24,85 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {} /** *

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 Amazon Web Services Region as the - * source bucket. To set the logging status of a bucket, you must be the bucket owner.

+ * modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services 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.

+ *

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:

+ *

+ * 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:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request.

    - *
    • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<> - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - *
    • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
    • - *
+ *
    + *
  • + *

    By the person's ID:

    + *

    + * <>ID<><>GranteesEmail<> + * + *

    + *

    DisplayName is optional and ignored in the request.

    + *
    • + *
  • + *

    By Email address:

    + *

    + * <>Grantees@email.com<> + *

    + *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object + * acl request, appears as the CanonicalUser.

    + *
    • + *
  • + *

    By URI:

    + *

    + * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> + *

    + *
    • + *
* * - *

To enable logging, you use LoggingEnabled and its children request elements. To disable - * logging, you use an empty BucketLoggingStatus request element:

+ *

To enable logging, you use LoggingEnabled and its children request elements. To disable + * logging, you use an empty BucketLoggingStatus request element:

* - *

- * - *

+ *

+ * + *

* - *

For more information about server access logging, see Server Access Logging.

+ *

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.

+ *

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:

- * + *

The following operations are related to PutBucketLogging:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts index 3f4f899..c73b1b3 100644 --- a/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts @@ -23,56 +23,56 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe /** *

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.

+ * 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.

+ *

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.

+ *

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon + * CloudWatch.

* - *

The following operations are related to - * PutBucketMetricsConfiguration:

- * + *

The following operations are related to + * PutBucketMetricsConfiguration:

+ * * - *

- * 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

      - *
      • - *
    - *
    • - *
+ *

+ * 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

      + *
      • + *
    + *
    • + *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts index 7f6d1a7..2fa6f91 100644 --- a/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts @@ -23,67 +23,67 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad /** *

Enables notifications of specified events for a bucket. For more information about event - * notifications, see Configuring Event - * Notifications.

+ * 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.

+ *

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.

+ *

By default, your bucket has no event notifications configured. That is, the notification + * configuration will be an empty NotificationConfiguration.

* - *

- * - *

- *

- * - *

- *

This action replaces the existing notification configuration with the configuration - * you include in the request body.

+ *

+ * + *

+ *

+ * + *

+ *

This action 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 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.

+ *

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 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.

+ *

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.

+ *

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 action will fail, and Amazon S3 will not add - * the configuration to your bucket.

- * + * + *

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 action 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.

+ *

+ * 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 action is related to - * PutBucketNotificationConfiguration:

- * + *

The following action is related to + * PutBucketNotificationConfiguration:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts b/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts index 6f7fa9c..9787207 100644 --- a/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts +++ b/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts @@ -24,22 +24,22 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare /** *

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this - * operation, you must have the s3:PutBucketOwnershipControls permission. For - * more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to PutBucketOwnershipControls:

- * + * operation, you must have the s3:PutBucketOwnershipControls permission. For + * more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

+ *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

+ *

The following operations are related to PutBucketOwnershipControls:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketPolicyCommand.ts b/clients/client-s3/src/commands/PutBucketPolicyCommand.ts index 0001950..7d419af 100644 --- a/clients/client-s3/src/commands/PutBucketPolicyCommand.ts +++ b/clients/client-s3/src/commands/PutBucketPolicyCommand.ts @@ -24,35 +24,35 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {} /** *

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than - * the root user of the Amazon Web Services 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.

+ * the root user of the Amazon Web Services 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.

+ *

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 Amazon Web Services 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, see Bucket policy examples.

+ * + *

As a security precaution, the root user of the Amazon Web Services 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, see Bucket policy examples.

* - *

The following operations are related to PutBucketPolicy:

- * + *

The following operations are related to PutBucketPolicy:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketReplicationCommand.ts b/clients/client-s3/src/commands/PutBucketReplicationCommand.ts index 0b44e30..ebcea8b 100644 --- a/clients/client-s3/src/commands/PutBucketReplicationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketReplicationCommand.ts @@ -24,75 +24,75 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {} /** *

Creates a replication configuration or replaces an existing one. For more information, - * see Replication in the Amazon S3 User Guide.

+ * see Replication in the Amazon S3 User Guide.

* - *

Specify the replication configuration in the request body. In the replication - * configuration, you provide the name of the destination bucket or buckets 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.

+ *

Specify the replication configuration in the request body. In the replication + * configuration, you provide the name of the destination bucket or buckets 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.

+ *

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.

* - *

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.

- * - *

If you are using an earlier version of the replication configuration, Amazon S3 handles - * replication of delete markers differently. For more information, see Backward Compatibility.

- * - *

For information about enabling versioning on a bucket, see Using Versioning.

+ *

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.

+ * + *

If you are using an earlier version of the replication configuration, Amazon S3 handles + * replication of delete markers differently. For more information, see Backward Compatibility.

+ * + *

For information about enabling versioning on a bucket, see Using Versioning.

* - *

- * 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 Amazon Web Services KMS. To replicate Amazon Web Services 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 Amazon Web Services KMS.

+ *

+ * 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 Amazon Web Services KMS. To replicate Amazon Web Services 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 Amazon Web Services KMS.

* - *

For information on PutBucketReplication errors, see List of - * replication-related error codes - *

+ *

For information on PutBucketReplication errors, see List of + * replication-related error codes + *

* - *

- * Permissions - *

- *

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration - * permissions for the bucket. - *

- *

By default, a resource owner, in this case the Amazon Web Services 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.

- * - *

To perform this operation, the user or role performing the action must have the - * iam:PassRole permission.

- * + *

+ * Permissions + *

+ *

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration + * permissions for the bucket. + *

+ *

By default, a resource owner, in this case the Amazon Web Services 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.

+ * + *

To perform this operation, the user or role performing the action must have the + * iam:PassRole permission.

+ * * - *

The following operations are related to PutBucketReplication:

- * + *

The following operations are related to PutBucketReplication:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts b/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts index bc6a723..2f9ccf4 100644 --- a/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts +++ b/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts @@ -24,24 +24,24 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer { /** *

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.

+ * 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:

- * + *

The following operations are related to PutBucketRequestPayment:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketTaggingCommand.ts b/clients/client-s3/src/commands/PutBucketTaggingCommand.ts index 1e98e32..21a93c9 100644 --- a/clients/client-s3/src/commands/PutBucketTaggingCommand.ts +++ b/clients/client-s3/src/commands/PutBucketTaggingCommand.ts @@ -24,84 +24,84 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {} /** *

Sets the tags for a bucket.

- *

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign - * up to get your Amazon Web Services 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 and Using Cost Allocation in Amazon S3 Bucket - * Tags.

+ *

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign + * up to get your Amazon Web Services 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 and Using Cost Allocation in Amazon S3 Bucket + * Tags.

* - * - *

- * When this operation sets the tags for a bucket, it will overwrite any current tags the - * bucket already has. You cannot use this operation to add tags to an existing list of 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.

+ * + *

+ * When this operation sets the tags for a bucket, it will overwrite any current tags the + * bucket already has. You cannot use this operation to add tags to an existing list of 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 - *

    - * - *
    • - *
  • - *

    Error code: MalformedXMLError - *

    - *
      - *
    • - *

      Description: The XML provided does not match the schema.

      - *
      • - *
    - *
    • - *
  • - *

    Error code: OperationAbortedError - *

    - *
      - *
    • - *

      Description: A conflicting conditional action 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.

      - *
      • - *
    - *
    • - *
+ *

+ * PutBucketTagging has the following special errors:

+ *
    + *
  • + *

    Error code: InvalidTagError + *

    + * + *
    • + *
  • + *

    Error code: MalformedXMLError + *

    + *
      + *
    • + *

      Description: The XML provided does not match the schema.

      + *
      • + *
    + *
    • + *
  • + *

    Error code: OperationAbortedError + *

    + *
      + *
    • + *

      Description: A conflicting conditional action 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:

- * + *

The following operations are related to PutBucketTagging:

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketVersioningCommand.ts b/clients/client-s3/src/commands/PutBucketVersioningCommand.ts index b40ee32..ed15395 100644 --- a/clients/client-s3/src/commands/PutBucketVersioningCommand.ts +++ b/clients/client-s3/src/commands/PutBucketVersioningCommand.ts @@ -24,54 +24,54 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {} /** *

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:

+ * 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.

+ *

+ * 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.

+ *

+ * 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 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 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.

- * + * + *

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 - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts b/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts index 2d9b85e..843d758 100644 --- a/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts +++ b/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts @@ -24,131 +24,131 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {} /** *

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.

+ * 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 action 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.

+ *

This PUT action 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 - *

    - *
    • - *
+ *

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 - *

    - *
    • - *
+ *

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 + *

    + *
    • + *
* - *

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more - * than 50 routing rules, you can use object redirect. For more information, see Configuring an - * Object Redirect in the Amazon S3 User Guide.

+ *

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more + * than 50 routing rules, you can use object redirect. For more information, see Configuring an + * Object Redirect in the Amazon S3 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutObjectAclCommand.ts b/clients/client-s3/src/commands/PutObjectAclCommand.ts index 9636fdf..e24b588 100644 --- a/clients/client-s3/src/commands/PutObjectAclCommand.ts +++ b/clients/client-s3/src/commands/PutObjectAclCommand.ts @@ -24,182 +24,182 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat /** *

Uses the acl subresource to set the access control list (ACL) permissions - * for a new or existing object in an S3 bucket. You must have WRITE_ACP - * permission to set the ACL of an object. For more information, see What - * permissions can I grant? in the Amazon S3 User Guide.

- *

This action is not supported by Amazon S3 on Outposts.

- *

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. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

+ * for a new or existing object in an S3 bucket. You must have WRITE_ACP + * permission to set the ACL of an object. For more information, see What + * permissions can I grant? in the Amazon S3 User Guide.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

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. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

* * * - *

- * 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 (Amazon Web Services 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.

    + *

    + * 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 (Amazon Web Services 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:

      + *

      You specify each grantee as a type=value pair, where the type is one of the + * following:

      + *
        + *
      • + *

        + * id – if the value specified is the canonical user ID of an Amazon Web Services account

        + *
        • + *
      • + *

        + * uri – if you are granting permissions to a predefined + * group

        + *
        • + *
      • + *

        + * emailAddress – if the value specified is the email address of + * an Amazon Web Services account

        + * + *

        Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

        *
          *
        • - *

          - * id – if the value specified is the canonical user ID of an Amazon Web Services account

          + *

          US East (N. Virginia)

          + *
          • + *
        • + *

          US West (N. California)

          + *
          • + *
        • + *

          US West (Oregon)

          + *
          • + *
        • + *

          Asia Pacific (Singapore)

          + *
          • + *
        • + *

          Asia Pacific (Sydney)

          *
          • *
        • - *

          - * uri – if you are granting permissions to a predefined - * group

          + *

          Asia Pacific (Tokyo)

          *
          • *
        • - *

          - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

          - * - *

          Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

          - *
            - *
          • - *

            US East (N. Virginia)

            - *
            • - *
          • - *

            US West (N. California)

            - *
            • - *
          • - *

            US West (Oregon)

            - *
            • - *
          • - *

            Asia Pacific (Singapore)

            - *
            • - *
          • - *

            Asia Pacific (Sydney)

            - *
            • - *
          • - *

            Asia Pacific (Tokyo)

            - *
            • - *
          • - *

            Europe (Ireland)

            - *
            • - *
          • - *

            South America (São Paulo)

            - *
            • - *
          - *

          For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

          - *           + *

          Europe (Ireland)

          + *
          • + *
        • + *

          South America (São Paulo)

          *
          • *
        - *

        For example, the following x-amz-grant-read header grants list - * objects permission to the two Amazon Web Services accounts identified by their email - * addresses.

        - *

        - * x-amz-grant-read: emailAddress="xyz@amazon.com", - * emailAddress="abc@amazon.com" - *

        + *

        For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

        + *         + *
        • + *
      + *

      For example, the following x-amz-grant-read header grants list + * objects permission to the two Amazon Web Services 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:

    + *
    • + *
+ *

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 the person's ID:

    + *

    + * <>ID<><>GranteesEmail<> + * + *

    + *

    DisplayName is optional and ignored in the request.

    + *
    • + *
  • + *

    By URI:

    + *

    + * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> + *

    + *
    • + *
  • + *

    By Email address:

    + *

    + * <>Grantees@email.com<>lt;/Grantee> + *

    + *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object + * acl request, appears as the CanonicalUser.

    + * + *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    *
      *
    • - *

      By the person's ID:

      - *

      - * <>ID<><>GranteesEmail<> - * - *

      - *

      DisplayName is optional and ignored in the request.

      + *

      US East (N. Virginia)

      *
      • *
    • - *

      By URI:

      - *

      - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

      + *

      US West (N. California)

      *
      • *
    • - *

      By Email address:

      - *

      - * <>Grantees@email.com<>lt;/Grantee> - *

      - *

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
        • - *
      • - *

        US West (N. California)

        - *
        • - *
      • - *

        US West (Oregon)

        - *
        • - *
      • - *

        Asia Pacific (Singapore)

        - *
        • - *
      • - *

        Asia Pacific (Sydney)

        - *
        • - *
      • - *

        Asia Pacific (Tokyo)

        - *
        • - *
      • - *

        Europe (Ireland)

        - *
        • - *
      • - *

        South America (São Paulo)

        - *
        • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *       + *

      US West (Oregon)

      + *
      • + *
    • + *

      Asia Pacific (Singapore)

      + *
      • + *
    • + *

      Asia Pacific (Sydney)

      + *
      • + *
    • + *

      Asia Pacific (Tokyo)

      *
      • - *
    - *

    - * 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 - *

      + *

      Europe (Ireland)

      *
      • *
    • - *

      - * GetObject - *

      + *

      South America (São Paulo)

      *
      • *
    + *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    + *     + *
    • + *
+ *

+ * 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 + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutObjectCommand.ts b/clients/client-s3/src/commands/PutObjectCommand.ts index 7ca8270..bd67f59 100644 --- a/clients/client-s3/src/commands/PutObjectCommand.ts +++ b/clients/client-s3/src/commands/PutObjectCommand.ts @@ -30,100 +30,100 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare /** *

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object - * to it.

+ * 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 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.

+ *

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 successfully complete the PutObject request, you must have the - * s3:PutObject in your IAM permissions.

    - *
    • - *
  • - *

    To successfully change the objects acl of your PutObject request, - * you must have the s3:PutObjectAcl in your IAM permissions.

    - *
    • - *
  • - *

    The Content-MD5 header is required for any request to upload an object - * with a retention period configured using Amazon S3 Object Lock. For more information about - * Amazon S3 Object Lock, see Amazon S3 Object Lock Overview - * in the Amazon S3 User Guide.

    - *
    • - *
- * + *

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 successfully complete the PutObject request, you must have the + * s3:PutObject in your IAM permissions.

    + *
    • + *
  • + *

    To successfully change the objects acl of your PutObject request, + * you must have the s3:PutObjectAcl in your IAM permissions.

    + *
    • + *
  • + *

    The Content-MD5 header is required for any request to upload an object + * with a retention period configured using Amazon S3 Object Lock. For more information about + * Amazon S3 Object Lock, see Amazon S3 Object Lock Overview + * in the Amazon S3 User Guide.

    + *
    • + *
+ * * - *

- * Server-side Encryption - *

- *

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 Amazon Web Services - * managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side - * Encryption.

- *

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable - * an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the - * Amazon S3 User Guide.

- *

- * Access Control List (ACL)-Specific Request - * Headers - *

- *

You can use headers to grant ACL- based permissions. By default, all objects are - * private. Only the owner has full access control. When adding a new object, you can grant - * permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These - * permissions are then added to the ACL on the object. For more information, see Access Control List - * (ACL) Overview and Managing ACLs Using the REST - * API.

+ *

+ * Server-side Encryption + *

+ *

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 Amazon Web Services + * managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side + * Encryption.

+ *

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable + * an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the + * Amazon S3 User Guide.

+ *

+ * Access Control List (ACL)-Specific Request + * Headers + *

+ *

You can use headers to grant ACL- based permissions. By default, all objects are + * private. Only the owner has full access control. When adding a new object, you can grant + * permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These + * permissions are then added to the ACL on the object. For more information, see Access Control List + * (ACL) Overview and Managing ACLs Using the REST + * API.

* - *

- * 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. Depending on - * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses - * the OUTPOSTS Storage Class. For more information, see Storage Classes in the - * Amazon S3 User Guide.

+ *

+ * 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. Depending on + * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses + * the OUTPOSTS Storage Class. For more information, see Storage Classes in the + * Amazon S3 User 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. When you enable - * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object - * simultaneously, it stores all of the objects.

- *

For more information about versioning, see Adding Objects to - * Versioning Enabled Buckets. For information about returning the versioning state - * of a bucket, see GetBucketVersioning.

+ *

+ * 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. When you enable + * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object + * simultaneously, it stores all of the objects.

+ *

For more information about versioning, see Adding Objects to + * Versioning Enabled Buckets. For information about returning the versioning state + * of a bucket, see GetBucketVersioning.

* * - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts b/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts index 33c4910..171bf0d 100644 --- a/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts +++ b/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts @@ -24,9 +24,9 @@ export interface PutObjectLegalHoldCommandOutput extends PutObjectLegalHoldOutpu /** *

Applies a Legal Hold configuration to the specified object. For more information, see - * Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ * Locking + * Objects.

+ *

This action is not supported by Amazon S3 on Outposts.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts b/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts index 364e653..3c98544 100644 --- a/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts @@ -24,26 +24,26 @@ export interface PutObjectLockConfigurationCommandOutput extends PutObjectLockCo /** *

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. For more information, see Locking Objects. + * Object Lock configuration will be applied by default to every new object placed in the + * specified bucket. For more information, see Locking Objects. *

- * - *
    - *
  • - *

    The DefaultRetention settings require both a mode and a - * period.

    - *
    • - *
  • - *

    The DefaultRetention period can be either Days - * or Years but you must select one. You cannot specify Days - * and Years at the same time.

    - *
    • - *
  • - *

    You can only enable Object Lock for new buckets. If you want to turn on - * Object Lock for an existing bucket, contact Amazon Web Services Support.

    - *
    • - *
- * + * + *
    + *
  • + *

    The DefaultRetention settings require both a mode and a + * period.

    + *
    • + *
  • + *

    The DefaultRetention period can be either Days + * or Years but you must select one. You cannot specify Days + * and Years at the same time.

    + *
    • + *
  • + *

    You can only enable Object Lock for new buckets. If you want to turn on + * Object Lock for an existing bucket, contact Amazon Web Services Support.

    + *
    • + *
+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutObjectRetentionCommand.ts b/clients/client-s3/src/commands/PutObjectRetentionCommand.ts index d4a8b4b..934116d 100644 --- a/clients/client-s3/src/commands/PutObjectRetentionCommand.ts +++ b/clients/client-s3/src/commands/PutObjectRetentionCommand.ts @@ -24,18 +24,18 @@ export interface PutObjectRetentionCommandOutput extends PutObjectRetentionOutpu /** *

Places an Object Retention configuration on an object. For more information, see Locking Objects. - * Users or accounts require the s3:PutObjectRetention permission in order to place - * an Object Retention configuration on objects. Bypassing a Governance Retention configuration - * requires the s3:BypassGovernanceRetention permission. - *

- *

This action is not supported by Amazon S3 on Outposts.

+ * Users or accounts require the s3:PutObjectRetention permission in order to place + * an Object Retention configuration on objects. Bypassing a Governance Retention configuration + * requires the s3:BypassGovernanceRetention permission. + *

+ *

This action is not supported by Amazon S3 on Outposts.

* - *

- * Permissions - *

- *

When the Object Lock retention mode is set to compliance, you need s3:PutObjectRetention and - * s3:BypassGovernanceRetention permissions. For other requests to PutObjectRetention, - * only s3:PutObjectRetention permissions are required.

+ *

+ * Permissions + *

+ *

When the Object Lock retention mode is set to compliance, you need s3:PutObjectRetention and + * s3:BypassGovernanceRetention permissions. For other requests to PutObjectRetention, + * only s3:PutObjectRetention permissions are required.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutObjectTaggingCommand.ts b/clients/client-s3/src/commands/PutObjectTaggingCommand.ts index b38d144..eb4f549 100644 --- a/clients/client-s3/src/commands/PutObjectTaggingCommand.ts +++ b/clients/client-s3/src/commands/PutObjectTaggingCommand.ts @@ -24,109 +24,109 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _ /** *

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.

+ *

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.

+ *

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 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.

+ *

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.

+ *

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 action 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. - *

      - *
      • - *
    - *
    • - *
+ *

+ * 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 action 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 - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/PutPublicAccessBlockCommand.ts b/clients/client-s3/src/commands/PutPublicAccessBlockCommand.ts index 4c5961a..d6c418c 100644 --- a/clients/client-s3/src/commands/PutPublicAccessBlockCommand.ts +++ b/clients/client-s3/src/commands/PutPublicAccessBlockCommand.ts @@ -24,50 +24,50 @@ export interface PutPublicAccessBlockCommandOutput extends __MetadataBearer {} /** *

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.

+ * 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.

- * + * + *

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".

+ *

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

* * * - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/RestoreObjectCommand.ts b/clients/client-s3/src/commands/RestoreObjectCommand.ts index 0edbc82..f9a2a0d 100644 --- a/clients/client-s3/src/commands/RestoreObjectCommand.ts +++ b/clients/client-s3/src/commands/RestoreObjectCommand.ts @@ -24,297 +24,297 @@ export interface RestoreObjectCommandOutput extends RestoreObjectOutput, __Metad /** *

Restores an archived copy of an object back into Amazon S3

- *

This action is not supported by Amazon S3 on Outposts.

- *

This action 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 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 S3 User 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 S3 User 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 Amazon Web Services Region as the bucket that contains the archive object that is - * being queried. The Amazon Web Services 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 S3 User Guide.

    - *

    For more information about the S3 structure in the request body, see - * the following:

    - * - *
    • - *
  • - *

    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 > 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 S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and - * S3 Glacier Select in the Amazon S3 User 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 objects - *

- *

Objects that you archive to the S3 Glacier or - * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or - * S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in - * Archive Access or Deep Archive Access tiers you must first initiate a restore request, and - * then wait until the object is moved into the Frequent Access tier. For objects in - * S3 Glacier or S3 Glacier Deep Archive storage classes you must - * first initiate a restore request, and then wait until a temporary copy of the object is - * available. To access an archived object, you must restore the object for the duration - * (number of days) that you specify.

- *

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.

- *

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 S3 Glacier - * storage class or S3 Intelligent-Tiering Archive tier 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 is 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 objects stored in the S3 Glacier Deep Archive - * storage class or S3 Intelligent-Tiering Deep Archive tier.

    - *
    • - *
  • - *

    - * - * Standard - * - Standard retrievals allow - * you to access any of your archived objects within several hours. This is the default - * option for retrieval requests that do not specify the retrieval option. Standard - * retrievals typically finish within 3–5 hours for objects stored in the - * S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They - * typically finish within 12 hours for objects stored in the - * S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. - * Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

    - *
    • - *
  • - *

    - * - * Bulk - * - Bulk retrievals are the - * lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, - * even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 - * hours for objects stored in the S3 Glacier storage class or - * S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored - * in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. - * Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

    - *
    • - *
- *

For more information about archive retrieval options and provisioned capacity for - * Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

- *

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed - * while it is in progress. For more information, see - * Upgrading the speed of an in-progress restore in the - * Amazon S3 User 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 S3 User 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 S3 User Guide.

- *

- * Responses - *

- *

A successful action returns either the 200 OK or 202 - * Accepted status code.

- *
    - *
  • - *

    If the object is not previously restored, then Amazon S3 returns 202 - * Accepted in the response.

    - *
    • - *
  • - *

    If the object 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: 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 - * S3 Standard or Bulk retrievals.) - *

      - *
      • - *
    • - *

      - * HTTP Status Code: 503 - *

      - *
      • - *
    • - *

      - * SOAP Fault Code Prefix: N/A - *

      - *
      • - *
    - *
    • - *
+ *

This action is not supported by Amazon S3 on Outposts.

+ *

This action 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 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 S3 User 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 S3 User 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 Amazon Web Services Region as the bucket that contains the archive object that is + * being queried. The Amazon Web Services 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 S3 User Guide.

    + *

    For more information about the S3 structure in the request body, see + * the following:

    + * + *
    • + *
  • + *

    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 > 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 S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and + * S3 Glacier Select in the Amazon S3 User 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 objects + *

+ *

Objects that you archive to the S3 Glacier or + * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or + * S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in + * Archive Access or Deep Archive Access tiers you must first initiate a restore request, and + * then wait until the object is moved into the Frequent Access tier. For objects in + * S3 Glacier or S3 Glacier Deep Archive storage classes you must + * first initiate a restore request, and then wait until a temporary copy of the object is + * available. To access an archived object, you must restore the object for the duration + * (number of days) that you specify.

+ *

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.

+ *

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 S3 Glacier + * storage class or S3 Intelligent-Tiering Archive tier 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 is 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 objects stored in the S3 Glacier Deep Archive + * storage class or S3 Intelligent-Tiering Deep Archive tier.

    + *
    • + *
  • + *

    + * + * Standard + * - Standard retrievals allow + * you to access any of your archived objects within several hours. This is the default + * option for retrieval requests that do not specify the retrieval option. Standard + * retrievals typically finish within 3–5 hours for objects stored in the + * S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They + * typically finish within 12 hours for objects stored in the + * S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. + * Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

    + *
    • + *
  • + *

    + * + * Bulk + * - Bulk retrievals are the + * lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, + * even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 + * hours for objects stored in the S3 Glacier storage class or + * S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored + * in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. + * Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

    + *
    • + *
+ *

For more information about archive retrieval options and provisioned capacity for + * Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

+ *

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed + * while it is in progress. For more information, see + * Upgrading the speed of an in-progress restore in the + * Amazon S3 User 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 S3 User 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 S3 User Guide.

+ *

+ * Responses + *

+ *

A successful action returns either the 200 OK or 202 + * Accepted status code.

+ *
    + *
  • + *

    If the object is not previously restored, then Amazon S3 returns 202 + * Accepted in the response.

    + *
    • + *
  • + *

    If the object 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: 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 + * S3 Standard or Bulk retrievals.) + *

      + *
      • + *
    • + *

      + * HTTP Status Code: 503 + *

      + *
      • + *
    • + *

      + * SOAP Fault Code Prefix: N/A + *

      + *
      • + *
    + *
    • + *
* - *

- * Related Resources - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/SelectObjectContentCommand.ts b/clients/client-s3/src/commands/SelectObjectContentCommand.ts index c59bea2..86f8ef0 100644 --- a/clients/client-s3/src/commands/SelectObjectContentCommand.ts +++ b/clients/client-s3/src/commands/SelectObjectContentCommand.ts @@ -25,122 +25,122 @@ export interface SelectObjectContentCommandOutput extends SelectObjectContentOut /** *

This action 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.

- *

This action is not supported by Amazon S3 on Outposts.

- *

For more information about Amazon S3 Select, - * see Selecting Content from - * Objects in the Amazon S3 User Guide.

- *

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select - * and S3 Glacier Select in the Amazon S3 User 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 S3 User 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 S3 User Guide.

    - *

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and - * customer master keys (CMKs) stored in Amazon Web Services 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 S3 User Guide.

    - *
    • - *
+ * 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.

+ *

This action is not supported by Amazon S3 on Outposts.

+ *

For more information about Amazon S3 Select, + * see Selecting Content from + * Objects in the Amazon S3 User Guide.

+ *

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select + * and S3 Glacier Select in the Amazon S3 User 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 S3 User 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 S3 User Guide.

    + *

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and + * customer master keys (CMKs) stored in Amazon Web Services 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 S3 User 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 Appendix: SelectObjectContent - * Response.

+ *

+ * 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 Appendix: SelectObjectContent + * Response.

* - *

- *

- * GetObject Support - *

- *

The SelectObjectContent action does not support the following - * GetObject functionality. For more information, see GetObject.

- *
    - *
  • - *

    - * Range: Although you can specify a scan range for an Amazon S3 Select request - * (see SelectObjectContentRequest - ScanRange in the request parameters), - * 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 S3 User Guide.

    - *
    • - *
- *

- *

- * Special Errors - *

+ *

+ *

+ * GetObject Support + *

+ *

The SelectObjectContent action does not support the following + * GetObject functionality. For more information, see GetObject.

+ *
    + *
  • + *

    + * Range: Although you can specify a scan range for an Amazon S3 Select request + * (see SelectObjectContentRequest - ScanRange in the request parameters), + * 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 S3 User Guide.

    + *
    • + *
+ *

+ *

+ * Special Errors + *

* - *

For a list of special errors for this operation, see List of - * SELECT Object Content Error Codes - *

- *

- * Related Resources - *

- * + *

For a list of special errors for this operation, see List of + * SELECT Object Content Error Codes + *

+ *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/UploadPartCommand.ts b/clients/client-s3/src/commands/UploadPartCommand.ts index a8501c8..389ac68 100644 --- a/clients/client-s3/src/commands/UploadPartCommand.ts +++ b/clients/client-s3/src/commands/UploadPartCommand.ts @@ -33,143 +33,143 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea /** *

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.

- * - *

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the - * x-amz-content-sha256 header as a checksum instead of - * Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version - * 4).

- * - * - * - *

- * 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 S3 User Guide .

- *

For information on the permissions required to use the multipart upload API, go to - * Multipart Upload and - * Permissions in the Amazon S3 User 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 Amazon Web Services 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 S3 User 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 - *

- * + * + *

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.

+ * + *

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the + * x-amz-content-sha256 header as a checksum instead of + * Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version + * 4).

+ * + * + * + *

+ * 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 S3 User Guide .

+ *

For information on the permissions required to use the multipart upload API, go to + * Multipart Upload and + * Permissions in the Amazon S3 User 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 Amazon Web Services 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 S3 User 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 + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/UploadPartCopyCommand.ts b/clients/client-s3/src/commands/UploadPartCopyCommand.ts index 2cfdee7..f8838f2 100644 --- a/clients/client-s3/src/commands/UploadPartCopyCommand.ts +++ b/clients/client-s3/src/commands/UploadPartCopyCommand.ts @@ -25,184 +25,184 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met /** *

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 S3 User Guide.

- * - *

Instead of using an existing object as part data, you might use the UploadPart - * action and provide data in your request.

- * + * 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 S3 User Guide.

+ * + *

Instead of using an existing object as part data, you might use the UploadPart + * action 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:

+ *

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 S3 User Guide.

    - *
    • - *
  • - *

    For information about permissions required to use the multipart upload API, see - * Multipart Upload and - * Permissions in the Amazon S3 User Guide.

    - *
    • - *
  • - *

    For information about copying objects using a single atomic action vs. the - * multipart upload, see Operations on - * Objects in the Amazon S3 User 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. - *

    + *
      + *
    • + *

      For conceptual information about multipart uploads, see Uploading Objects Using Multipart + * Upload in the Amazon S3 User Guide.

      + *
      • + *
    • + *

      For information about permissions required to use the multipart upload API, see + * Multipart Upload and + * Permissions in the Amazon S3 User Guide.

      + *
      • + *
    • + *

      For information about copying objects using a single atomic action vs. the + * multipart upload, see Operations on + * Objects in the Amazon S3 User 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 - *

    + *
    • + *
  • + *

    + * 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 - *

      - *
      • - *
    - *
    • - *
+ *

+ * 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 - *

- * + *

+ * Related Resources + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts b/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts index 0b40c5a..6cefc24 100644 --- a/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts +++ b/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts @@ -32,28 +32,28 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {} /** *

Passes transformed - * objects to a GetObject operation when using Object Lambda Access Points. For information about - * Object Lambda Access Points, see Transforming objects with - * Object Lambda Access Points in the Amazon S3 User Guide.

- *

This operation supports metadata that can be returned by GetObject, in addition to - * RequestRoute, RequestToken, StatusCode, - * ErrorCode, and ErrorMessage. The GetObject + * objects to a GetObject operation when using Object Lambda Access Points. For information about + * Object Lambda Access Points, see Transforming objects with + * Object Lambda Access Points in the Amazon S3 User Guide.

+ *

This operation supports metadata that can be returned by GetObject, in addition to + * RequestRoute, RequestToken, StatusCode, + * ErrorCode, and ErrorMessage. The GetObject * response metadata is supported so that the WriteGetObjectResponse caller, * typically an Lambda function, can provide the same metadata when it internally invokes - * GetObject. When WriteGetObjectResponse is called by a + * GetObject. When WriteGetObjectResponse is called by a * customer-owned Lambda function, the metadata returned to the end user - * GetObject call might differ from what Amazon S3 would normally return.

- *

You can include any number of metadata headers. When including a metadata header, it should be - * prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. - * The primary use case for this is to forward GetObject metadata.

- *

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact - * personally identifiable information (PII) and decompress S3 objects. These Lambda functions - * are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your - * Object Lambda Access Point.

- *

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

- *

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

- *

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

- *

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

+ * GetObject call might differ from what Amazon S3 would normally return.

+ *

You can include any number of metadata headers. When including a metadata header, it should be + * prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. + * The primary use case for this is to forward GetObject metadata.

+ *

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact + * personally identifiable information (PII) and decompress S3 objects. These Lambda functions + * are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your + * Object Lambda Access Point.

+ *

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

+ *

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

+ *

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

+ *

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-s3/src/models/models_0.ts b/clients/client-s3/src/models/models_0.ts index f3cb0fc..339cdd3 100644 --- a/clients/client-s3/src/models/models_0.ts +++ b/clients/client-s3/src/models/models_0.ts @@ -4,14 +4,14 @@ import { Readable } from "stream"; /** *

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will - * wait before permanently removing all parts of the upload. For more information, see - * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the - * Amazon S3 User Guide.

+ * wait before permanently removing all parts of the upload. For more information, see + * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the + * Amazon S3 User Guide.

*/ export interface AbortIncompleteMultipartUpload { /** *

Specifies the number of days after which Amazon S3 aborts an incomplete multipart - * upload.

+ * upload.

*/ DaysAfterInitiation?: number; } @@ -30,7 +30,7 @@ export type RequestCharged = "requester"; export interface AbortMultipartUploadOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -49,8 +49,8 @@ export type RequestPayer = "requester"; export interface AbortMultipartUploadRequest { /** *

The bucket name to which the upload was taking place.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -66,9 +66,9 @@ export interface AbortMultipartUploadRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -108,8 +108,8 @@ export type BucketAccelerateStatus = "Enabled" | "Suspended"; /** *

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see - * Amazon S3 - * Transfer Acceleration in the Amazon S3 User Guide.

+ * Amazon S3 + * Transfer Acceleration in the Amazon S3 User Guide.

*/ export interface AccelerateConfiguration { /** @@ -140,36 +140,36 @@ export interface Grantee { /** *

Email address of the grantee.

- * - *

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

- *
    - *
  • - *

    US East (N. Virginia)

    - *
    • - *
  • - *

    US West (N. California)

    - *
    • - *
  • - *

    US West (Oregon)

    - *
    • - *
  • - *

    Asia Pacific (Singapore)

    - *
    • - *
  • - *

    Asia Pacific (Sydney)

    - *
    • - *
  • - *

    Asia Pacific (Tokyo)

    - *
    • - *
  • - *

    Europe (Ireland)

    - *
    • - *
  • - *

    South America (São Paulo)

    - *
    • - *
- *

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

- * + * + *

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

+ *
    + *
  • + *

    US East (N. Virginia)

    + *
    • + *
  • + *

    US West (N. California)

    + *
    • + *
  • + *

    US West (Oregon)

    + *
    • + *
  • + *

    Asia Pacific (Singapore)

    + *
    • + *
  • + *

    Asia Pacific (Sydney)

    + *
    • + *
  • + *

    Asia Pacific (Tokyo)

    + *
    • + *
  • + *

    Europe (Ireland)

    + *
    • + *
  • + *

    South America (São Paulo)

    + *
    • + *
+ *

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

+ * */ EmailAddress?: string; @@ -280,7 +280,7 @@ export type OwnerOverride = "Destination"; export interface AccessControlTranslation { /** *

Specifies the replica ownership. For default and valid values, see PUT bucket - * replication in the Amazon S3 API Reference.

+ * replication in the Amazon S3 API Reference.

*/ Owner: OwnerOverride | string | undefined; } @@ -304,8 +304,8 @@ export interface CompleteMultipartUploadOutput { /** *

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket?: string; @@ -316,36 +316,36 @@ export interface CompleteMultipartUploadOutput { /** *

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.

+ * (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

*/ Expiration?: string; /** *

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.

+ * 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.

*/ ETag?: string; /** *

If you specified server-side encryption either with an Amazon S3-managed encryption key or an - * Amazon Web Services 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.

+ * Amazon Web Services 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.

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

Version ID of the newly created object, in case the bucket has versioning turned - * on.

+ * on.

*/ VersionId?: string; /** *

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed customer master key (CMK) that was used for the object.

+ * customer managed customer master key (CMK) that was used for the object.

*/ SSEKMSKeyId?: string; @@ -356,7 +356,7 @@ export interface CompleteMultipartUploadOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -382,7 +382,7 @@ export interface CompletedPart { /** *

Part number that identifies the part. This is a positive integer between 1 and - * 10,000.

+ * 10,000.

*/ PartNumber?: number; } @@ -418,8 +418,8 @@ export namespace CompletedMultipartUpload { export interface CompleteMultipartUploadRequest { /** *

Name of the bucket to which the multipart upload was initiated.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -440,9 +440,9 @@ export interface CompleteMultipartUploadRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -508,33 +508,33 @@ export interface CopyObjectOutput { /** *

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

+ * AES256, aws:kms).

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

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

+ * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

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

+ * response will include this header to provide round-trip message integrity verification of + * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed customer master key (CMK) that was used for the object.

+ * customer managed customer master key (CMK) that was used for the object.

*/ SSEKMSKeyId?: string; /** *

If present, specifies the Amazon Web Services 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.

+ * value of this header is a base64-encoded UTF-8 string holding JSON with the encryption + * context key-value pairs.

*/ SSEKMSEncryptionContext?: string; @@ -545,7 +545,7 @@ export interface CopyObjectOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -591,14 +591,14 @@ export type TaggingDirective = "COPY" | "REPLACE"; export interface CopyObjectRequest { /** *

The canned ACL to apply to the object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

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

The name of the destination bucket.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -614,8 +614,8 @@ export interface CopyObjectRequest { /** *

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.

+ * mechanisms must be applied to obtain the media-type referenced by the Content-Type header + * field.

*/ ContentEncoding?: string; @@ -631,29 +631,29 @@ export interface CopyObjectRequest { /** *

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

- *
    - *
  • - *

    For objects not accessed through an access point, specify the name of the source - * bucket and the key of the source object, separated by a slash (/). For example, to - * copy the object reports/january.pdf from the bucket - * awsexamplebucket, use - * awsexamplebucket/reports/january.pdf. The value must be URL - * encoded.

    - *
    • - *
  • - *

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    - * - *

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    - *     - *

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    - *
    • - *
- *

To copy a specific version of an object, append ?versionId= - * to the value (for example, - * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). - * If you don't specify a version ID, Amazon S3 copies the latest version of the source - * object.

+ * formats, depending on whether you want to access the source object through an access point:

+ *
    + *
  • + *

    For objects not accessed through an access point, specify the name of the source + * bucket and the key of the source object, separated by a slash (/). For example, to + * copy the object reports/january.pdf from the bucket + * awsexamplebucket, use + * awsexamplebucket/reports/january.pdf. The value must be URL + * encoded.

    + *
    • + *
  • + *

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    + * + *

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    + *     + *

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    + *
    • + *
+ *

To copy a specific version of an object, append ?versionId= + * to the value (for example, + * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). + * If you don't specify a version ID, Amazon S3 copies the latest version of the source + * object.

*/ CopySource: string | undefined; @@ -685,27 +685,27 @@ export interface CopyObjectRequest { /** *

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the * object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantFullControl?: string; /** *

Allows grantee to read the object data and its * metadata.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantRead?: string; /** *

Allows grantee to read the object ACL.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantReadACP?: string; /** *

Allows grantee to write the ACL for the applicable * object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantWriteACP?: string; @@ -721,113 +721,113 @@ export interface CopyObjectRequest { /** *

Specifies whether the metadata is copied from the source object or replaced with - * metadata provided in the request.

+ * metadata provided in the request.

*/ MetadataDirective?: MetadataDirective | string; /** *

Specifies whether the object tag-set are copied from the source object or replaced with - * tag-set provided in the request.

+ * tag-set provided in the request.

*/ TaggingDirective?: TaggingDirective | string; /** *

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

+ * AES256, aws:kms).

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The - * STANDARD storage class provides high durability and high availability. Depending on - * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses - * the OUTPOSTS Storage Class. For more information, see Storage Classes in the - * Amazon S3 User Guide.

+ * STANDARD storage class provides high durability and high availability. Depending on + * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses + * the OUTPOSTS Storage Class. For more information, see Storage Classes in the + * Amazon S3 User Guide.

*/ StorageClass?: StorageClass | string; /** *

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.

+ * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in + * the object metadata.

*/ WebsiteRedirectLocation?: string; /** *

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

+ * AES256).

*/ SSECustomerAlgorithm?: string; /** *

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

+ * 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.

*/ SSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ SSECustomerKeyMD5?: string; /** *

Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for - * an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For - * information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, - * see Specifying the - * Signature Version in Request Authentication in the Amazon S3 User Guide.

+ * an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For + * information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, + * see Specifying the + * Signature Version in Request Authentication in the Amazon S3 User Guide.

*/ SSEKMSKeyId?: string; /** *

Specifies the Amazon Web Services 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.

+ * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value + * pairs.

*/ SSEKMSEncryptionContext?: string; /** *

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

- *

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

+ *

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

*/ BucketKeyEnabled?: boolean; /** *

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

+ * AES256).

*/ CopySourceSSECustomerAlgorithm?: string; /** *

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

+ * object. The encryption key provided in this header must be one that was used when the + * source object was created.

*/ CopySourceSSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ CopySourceSSECustomerKeyMD5?: string; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

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

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.

+ * with the TaggingDirective. The tag-set must be encoded as URL Query + * parameters.

*/ Tagging?: string; @@ -872,7 +872,7 @@ export namespace CopyObjectRequest { /** *

The source object of the COPY action is not in the active tier and is only stored in - * Amazon S3 Glacier.

+ * Amazon S3 Glacier.

*/ export interface ObjectNotInActiveTierError extends __SmithyException, $MetadataBearer { name: "ObjectNotInActiveTierError"; @@ -890,7 +890,7 @@ export namespace ObjectNotInActiveTierError { /** *

The requested bucket name is not available. The bucket namespace is shared by all users - * of the system. Select a different name and try again.

+ * of the system. Select a different name and try again.

*/ export interface BucketAlreadyExists extends __SmithyException, $MetadataBearer { name: "BucketAlreadyExists"; @@ -908,9 +908,9 @@ export namespace BucketAlreadyExists { /** *

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error - * in all Amazon Web Services 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).

+ * in all Amazon Web Services 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).

*/ export interface BucketAlreadyOwnedByYou extends __SmithyException, $MetadataBearer { name: "BucketAlreadyOwnedByYou"; @@ -929,8 +929,8 @@ export namespace BucketAlreadyOwnedByYou { export interface CreateBucketOutput { /** *

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.

+ * the US East (N. Virginia) Region (us-east-1), you do not need to specify the + * location.

*/ Location?: string; } @@ -979,7 +979,7 @@ export type BucketLocationConstraint = export interface CreateBucketConfiguration { /** *

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).

+ * the bucket is created in the US East (N. Virginia) Region (us-east-1).

*/ LocationConstraint?: BucketLocationConstraint | string; } @@ -1006,7 +1006,7 @@ export interface CreateBucketRequest { /** *

Allows grantee the read, write, read ACP, and write ACP permissions on the - * bucket.

+ * bucket.

*/ GrantFullControl?: string; @@ -1022,7 +1022,7 @@ export interface CreateBucketRequest { /** *

Allows grantee to create new objects in the bucket.

- *

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

+ *

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

*/ GrantWrite?: string; @@ -1054,27 +1054,27 @@ export namespace CreateBucketRequest { export interface CreateMultipartUploadOutput { /** *

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.

+ * 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.

+ *

The response also includes the x-amz-abort-rule-id header that provides the + * ID of the lifecycle configuration rule that defines this action.

*/ AbortDate?: Date; /** *

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.

+ * identifies the applicable lifecycle configuration rule that defines the action to abort + * incomplete multipart uploads.

*/ AbortRuleId?: string; /** *

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket?: string; @@ -1090,33 +1090,33 @@ export interface CreateMultipartUploadOutput { /** *

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

+ * AES256, aws:kms).

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

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

+ * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

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

+ * response will include this header to provide round-trip message integrity verification of + * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed customer master key (CMK) that was used for the object.

+ * customer managed customer master key (CMK) that was used for the object.

*/ SSEKMSKeyId?: string; /** *

If present, specifies the Amazon Web Services 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.

+ * value of this header is a base64-encoded UTF-8 string holding JSON with the encryption + * context key-value pairs.

*/ SSEKMSEncryptionContext?: string; @@ -1127,7 +1127,7 @@ export interface CreateMultipartUploadOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -1146,14 +1146,14 @@ export namespace CreateMultipartUploadOutput { export interface CreateMultipartUploadRequest { /** *

The canned ACL to apply to the object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

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

The name of the bucket to which to initiate the upload

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -1169,8 +1169,8 @@ export interface CreateMultipartUploadRequest { /** *

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.

+ * mechanisms must be applied to obtain the media-type referenced by the Content-Type header + * field.

*/ ContentEncoding?: string; @@ -1192,27 +1192,27 @@ export interface CreateMultipartUploadRequest { /** *

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the * object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantFullControl?: string; /** *

Allows grantee to read the object data and its * metadata.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantRead?: string; /** *

Allows grantee to read the object ACL.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantReadACP?: string; /** *

Allows grantee to write the ACL for the applicable * object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantWriteACP?: string; @@ -1228,74 +1228,74 @@ export interface CreateMultipartUploadRequest { /** *

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

+ * AES256, aws:kms).

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The - * STANDARD storage class provides high durability and high availability. Depending on - * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses - * the OUTPOSTS Storage Class. For more information, see Storage Classes in the - * Amazon S3 User Guide.

+ * STANDARD storage class provides high durability and high availability. Depending on + * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses + * the OUTPOSTS Storage Class. For more information, see Storage Classes in the + * Amazon S3 User Guide.

*/ StorageClass?: StorageClass | string; /** *

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.

+ * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in + * the object metadata.

*/ WebsiteRedirectLocation?: string; /** *

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

+ * AES256).

*/ SSECustomerAlgorithm?: string; /** *

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

+ * 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.

*/ SSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ SSECustomerKeyMD5?: string; /** *

Specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for object - * encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not - * made via SSL or using SigV4. For information about configuring using any of the officially - * supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication - * in the Amazon S3 User Guide.

+ * encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not + * made via SSL or using SigV4. For information about configuring using any of the officially + * supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication + * in the Amazon S3 User Guide.

*/ SSEKMSKeyId?: string; /** *

Specifies the Amazon Web Services 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.

+ * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value + * pairs.

*/ SSEKMSEncryptionContext?: string; /** *

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

- *

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

+ *

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

*/ BucketKeyEnabled?: boolean; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -1408,7 +1408,7 @@ export namespace DeleteBucketCorsRequest { export interface DeleteBucketEncryptionRequest { /** *

The name of the bucket containing the server-side encryption configuration to - * delete.

+ * delete.

*/ Bucket: string | undefined; @@ -1629,19 +1629,19 @@ export namespace DeleteBucketWebsiteRequest { export interface DeleteObjectOutput { /** *

Specifies whether the versioned object that was permanently deleted was (true) or was - * not (false) a delete marker.

+ * not (false) a delete marker.

*/ DeleteMarker?: boolean; /** *

Returns the version ID of the delete marker created as a result of the DELETE - * operation.

+ * operation.

*/ VersionId?: string; /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -1658,8 +1658,8 @@ export namespace DeleteObjectOutput { export interface DeleteObjectRequest { /** *

The bucket name of the bucket containing the object.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -1670,8 +1670,8 @@ export interface DeleteObjectRequest { /** *

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.

+ * that is displayed on your authentication device. Required to permanently delete a versioned + * object if versioning is configured with MFA delete enabled.

*/ MFA?: string; @@ -1682,16 +1682,16 @@ export interface DeleteObjectRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

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

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process - * this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock - * permission.

+ * this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock + * permission.

*/ BypassGovernanceRetention?: boolean; @@ -1726,15 +1726,15 @@ export interface DeletedObject { /** *

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.

+ * not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or + * not (false) a delete marker was created.

*/ DeleteMarker?: boolean; /** *

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.

+ * delete a specific object version, the value returned by this header is the version ID of + * the object version deleted.

*/ DeleteMarkerVersionId?: string; } @@ -1764,1878 +1764,1878 @@ export interface _Error { /** *

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 + * 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 Amazon Web Services account + * that prevents the action from completing successfully. Contact Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 action 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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." *

      - *
        - *
      • - *
          - *
        • - *

          - * Code: AccessDenied

          - *
          • - *
        • - *

          - * Description: Access Denied

          - *
          • - *
        • - *

          - * HTTP Status Code: 403 Forbidden

          - *
          • - *
        • - *

          - * SOAP Fault Code Prefix: Client

          - *
          • - *
        - *
        • - *
      • - *
          - *
        • - *

          - * Code: AccountProblem

          - *
          • - *
        • - *

          - * Description: There is a problem with your Amazon Web Services account - * that prevents the action from completing successfully. Contact Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 action 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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: Amazon S3 - *

          - *
          • - *
        • - *

          - * HTTP Status Code: 403 Forbidden

          - *
          • - *
        • - *

          - * SOAP Fault Code Prefix: Client

          - *
          • - *
        - *
        • - *
      • - *
          - *
        • - *

          - * Code: OperationAborted

          - *
          • - *
        • - *

          - * Description: A conflicting conditional action 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 Amazon Web Services 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

          - *
          • - *
        - *
        • - *
      - *

      + *
      • + *
    • + *

      + * 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: Amazon S3 + *

      + *
      • + *
    • + *

      + * HTTP Status Code: 403 Forbidden

      + *
      • + *
    • + *

      + * SOAP Fault Code Prefix: Client

      + *
      • + *
    + *
    • + *
  • + *
      + *
    • + *

      + * Code: OperationAborted

      + *
      • + *
    • + *

      + * Description: A conflicting conditional action 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 Amazon Web Services 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

      + *
      • + *
    + *
    • + *
+ *

*/ Code?: string; /** *

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.

+ * 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.

*/ Message?: string; } @@ -3652,19 +3652,19 @@ export namespace _Error { export interface DeleteObjectsOutput { /** *

Container element for a successful delete. It identifies the object that was - * successfully deleted.

+ * successfully deleted.

*/ Deleted?: DeletedObject[]; /** *

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

+ * request.

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

Container for a failed delete action that describes the object that Amazon S3 attempted to - * delete and the error it encountered.

+ * delete and the error it encountered.

*/ Errors?: _Error[]; } @@ -3684,11 +3684,11 @@ export namespace DeleteObjectsOutput { export interface ObjectIdentifier { /** *

Key name of the object.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ Key: string | undefined; @@ -3718,7 +3718,7 @@ export interface Delete { /** *

Element to enable quiet mode for the request. When you add this element, you must set - * its value to true.

+ * its value to true.

*/ Quiet?: boolean; } @@ -3735,30 +3735,30 @@ export namespace Delete { export interface DeleteObjectsRequest { /** *

The bucket name containing the objects to delete.

- *

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

- *

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

+ *

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

+ *

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

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

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.

+ * that is displayed on your authentication device. Required to permanently delete a versioned + * object if versioning is configured with MFA delete enabled.

*/ MFA?: string; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

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

Specifies whether you want to delete this object even if it has a Governance-type Object - * Lock in place. To use this header, you must have the s3:PutBucketPublicAccessBlock - * permission.

+ * Lock in place. To use this header, you must have the s3:PutBucketPublicAccessBlock + * permission.

*/ BypassGovernanceRetention?: boolean; @@ -3801,8 +3801,8 @@ export namespace DeleteObjectTaggingOutput { export interface DeleteObjectTaggingRequest { /** *

The bucket name containing the objects from which to remove the tags.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -3958,13 +3958,13 @@ export namespace Tag { /** *

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. - * The operator must have at least two predicates in any combination, and an object must match - * all of the predicates for the filter to apply.

+ * The operator must have at least two predicates in any combination, and an object must match + * all of the predicates for the filter to apply.

*/ export interface AnalyticsAndOperator { /** *

The prefix to use when evaluating an AND predicate: The prefix that an object must have - * to be included in the metrics results.

+ * to be included in the metrics results.

*/ Prefix?: string; @@ -3985,8 +3985,8 @@ export namespace AnalyticsAndOperator { /** *

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.

+ * one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, + * all objects will be considered in any analysis.

*/ export type AnalyticsFilter = | AnalyticsFilter.AndMember @@ -4017,7 +4017,7 @@ export namespace AnalyticsFilter { /** *

A conjunction (logical AND) of predicates, which is used in evaluating an analytics - * filter. The operator must have at least two predicates.

+ * filter. The operator must have at least two predicates.

*/ export interface AndMember { Prefix?: never; @@ -4071,11 +4071,11 @@ export interface AnalyticsS3BucketDestination { /** *

The account ID that owns the destination S3 bucket. If no account ID is provided, the - * owner is not validated before exporting data.

- * - *

Although this value is optional, we strongly recommend that you set it to help - * prevent problems if the destination bucket ownership changes.

- * + * owner is not validated before exporting data.

+ * + *

Although this value is optional, we strongly recommend that you set it to help + * prevent problems if the destination bucket ownership changes.

+ * */ BucketAccountId?: string; @@ -4122,12 +4122,12 @@ export type StorageClassAnalysisSchemaVersion = "V_1"; /** *

Container for data related to the storage class analysis for an Amazon S3 bucket for - * export.

+ * export.

*/ export interface StorageClassAnalysisDataExport { /** *

The version of the output schema to use when exporting data. Must be - * V_1.

+ * V_1.

*/ OutputSchemaVersion: StorageClassAnalysisSchemaVersion | string | undefined; @@ -4148,12 +4148,12 @@ export namespace StorageClassAnalysisDataExport { /** *

Specifies data related to access patterns to be collected and made available to analyze - * the tradeoffs between different storage classes for an Amazon S3 bucket.

+ * the tradeoffs between different storage classes for an Amazon S3 bucket.

*/ export interface StorageClassAnalysis { /** *

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be - * exported.

+ * exported.

*/ DataExport?: StorageClassAnalysisDataExport; } @@ -4178,14 +4178,14 @@ export interface AnalyticsConfiguration { /** *

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.

+ * one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, + * all objects will be considered in any analysis.

*/ Filter?: AnalyticsFilter; /** *

Contains data related to access patterns to be collected and made available to analyze - * the tradeoffs between different storage classes.

+ * the tradeoffs between different storage classes.

*/ StorageClassAnalysis: StorageClassAnalysis | undefined; } @@ -4256,14 +4256,14 @@ export interface CORSRule { /** *

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.

+ * 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.

*/ AllowedHeaders?: string[]; /** *

An HTTP method that you allow the origin to execute. Valid values are GET, - * PUT, HEAD, POST, and DELETE.

+ * PUT, HEAD, POST, and DELETE.

*/ AllowedMethods: string[] | undefined; @@ -4274,14 +4274,14 @@ export interface CORSRule { /** *

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).

+ * their applications (for example, from a JavaScript XMLHttpRequest + * object).

*/ ExposeHeaders?: string[]; /** *

The time in seconds that your browser is to cache the preflight response for the - * specified resource.

+ * specified resource.

*/ MaxAgeSeconds?: number; } @@ -4298,7 +4298,7 @@ export namespace CORSRule { export interface GetBucketCorsOutput { /** *

A set of origins and methods (cross-origin access that you want to allow). You can add - * up to 100 rules to the configuration.

+ * up to 100 rules to the configuration.

*/ CORSRules?: CORSRule[]; } @@ -4335,9 +4335,9 @@ export namespace GetBucketCorsRequest { /** *

Describes 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. For more information, see PUT Bucket encryption in - * the Amazon S3 API Reference.

+ * PUT Object request doesn't specify any server-side encryption, this default encryption will + * be applied. For more information, see PUT Bucket encryption in + * the Amazon S3 API Reference.

*/ export interface ServerSideEncryptionByDefault { /** @@ -4349,28 +4349,28 @@ export interface ServerSideEncryptionByDefault { *

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default * encryption. This parameter is allowed if and only if SSEAlgorithm is set to * aws:kms.

- *

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you + *

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you * are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. * For more information, see Using encryption for cross-account operations.

- *

- * For example: - *

- *
    - *
  • - *

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
  • - *

    Key ARN: - * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - *

    - *
    • - *
- * - *

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see - * Using symmetric and - * asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

- * + *

+ * For example: + *

+ *
    + *
  • + *

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + *

    + *
    • + *
  • + *

    Key ARN: + * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + *

    + *
    • + *
+ * + *

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see + * Using symmetric and + * asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

+ * */ KMSMasterKeyID?: string; } @@ -4391,14 +4391,14 @@ export namespace ServerSideEncryptionByDefault { export interface ServerSideEncryptionRule { /** *

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.

+ * PUT Object request doesn't specify any server-side encryption, this default encryption will + * be applied.

*/ ApplyServerSideEncryptionByDefault?: ServerSideEncryptionByDefault; /** *

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

- *

For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

+ *

For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

*/ BucketKeyEnabled?: boolean; } @@ -4423,7 +4423,7 @@ export namespace ServerSideEncryptionRule { export interface ServerSideEncryptionConfiguration { /** *

Container for information about a particular server-side encryption configuration - * rule.

+ * rule.

*/ Rules: ServerSideEncryptionRule[] | undefined; } @@ -4462,7 +4462,7 @@ export namespace GetBucketEncryptionOutput { export interface GetBucketEncryptionRequest { /** *

The name of the bucket from which the server-side encryption configuration is - * retrieved.

+ * retrieved.

*/ Bucket: string | undefined; @@ -4483,18 +4483,18 @@ export namespace GetBucketEncryptionRequest { /** *

A container for specifying S3 Intelligent-Tiering filters. The filters determine the - * subset of objects to which the rule applies.

+ * subset of objects to which the rule applies.

*/ export interface IntelligentTieringAndOperator { /** *

An object key name prefix that identifies the subset of objects to which the - * configuration applies.

+ * configuration applies.

*/ Prefix?: string; /** *

All of these tags must exist in the object's tag set in order for the configuration to - * apply.

+ * apply.

*/ Tags?: Tag[]; } @@ -4510,17 +4510,17 @@ export namespace IntelligentTieringAndOperator { /** *

The Filter is used to identify objects that the S3 Intelligent-Tiering - * configuration applies to.

+ * configuration applies to.

*/ export interface IntelligentTieringFilter { /** *

An object key name prefix that identifies the subset of objects to which the rule - * applies.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * applies.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ Prefix?: string; @@ -4531,8 +4531,8 @@ export interface IntelligentTieringFilter { /** *

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.

+ * The operator must have at least two predicates, and an object must match all of the + * predicates in order for the filter to apply.

*/ And?: IntelligentTieringAndOperator; } @@ -4552,22 +4552,22 @@ export type IntelligentTieringAccessTier = "ARCHIVE_ACCESS" | "DEEP_ARCHIVE_ACCE /** *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by - * automatically moving data to the most cost-effective storage access tier, without - * additional operational overhead.

+ * automatically moving data to the most cost-effective storage access tier, without + * additional operational overhead.

*/ export interface Tiering { /** *

The number of consecutive days of no access after which an object will be eligible to be - * transitioned to the corresponding tier. The minimum number of days specified for - * Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least - * 180 days. The maximum can be up to 2 years (730 days).

+ * transitioned to the corresponding tier. The minimum number of days specified for + * Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least + * 180 days. The maximum can be up to 2 years (730 days).

*/ Days: number | undefined; /** *

S3 Intelligent-Tiering access tier. See Storage class for - * automatically optimizing frequently and infrequently accessed objects for a list - * of access tiers in the S3 Intelligent-Tiering storage class.

+ * automatically optimizing frequently and infrequently accessed objects for a list + * of access tiers in the S3 Intelligent-Tiering storage class.

*/ AccessTier: IntelligentTieringAccessTier | string | undefined; } @@ -4583,8 +4583,8 @@ export namespace Tiering { /** *

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

- *

For information about the S3 Intelligent-Tiering storage class, see Storage class for - * automatically optimizing frequently and infrequently accessed objects.

+ *

For information about the S3 Intelligent-Tiering storage class, see Storage class for + * automatically optimizing frequently and infrequently accessed objects.

*/ export interface IntelligentTieringConfiguration { /** @@ -4594,7 +4594,7 @@ export interface IntelligentTieringConfiguration { /** *

Specifies a bucket filter. The configuration only includes objects that meet the - * filter's criteria.

+ * filter's criteria.

*/ Filter?: IntelligentTieringFilter; @@ -4661,7 +4661,7 @@ export namespace GetBucketIntelligentTieringConfigurationRequest { export interface SSEKMS { /** *

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed - * customer master key (CMK) to use for encrypting inventory reports.

+ * customer master key (CMK) to use for encrypting inventory reports.

*/ KeyId: string | undefined; } @@ -4692,7 +4692,7 @@ export namespace SSES3 { /** *

Contains the type of server-side encryption used to encrypt the inventory - * results.

+ * results.

*/ export interface InventoryEncryption { /** @@ -4720,22 +4720,22 @@ export type InventoryFormat = "CSV" | "ORC" | "Parquet"; /** *

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) - * where inventory results are published.

+ * where inventory results are published.

*/ export interface InventoryS3BucketDestination { /** *

The account ID that owns the destination S3 bucket. If no account ID is provided, the - * owner is not validated before exporting data.

- * - *

Although this value is optional, we strongly recommend that you set it to help - * prevent problems if the destination bucket ownership changes.

- * + * owner is not validated before exporting data.

+ * + *

Although this value is optional, we strongly recommend that you set it to help + * prevent problems if the destination bucket ownership changes.

+ * */ AccountId?: string; /** *

The Amazon Resource Name (ARN) of the bucket where inventory results will be - * published.

+ * published.

*/ Bucket: string | undefined; @@ -4751,7 +4751,7 @@ export interface InventoryS3BucketDestination { /** *

Contains the type of server-side encryption used to encrypt the inventory - * results.

+ * results.

*/ Encryption?: InventoryEncryption; } @@ -4772,7 +4772,7 @@ export namespace InventoryS3BucketDestination { export interface InventoryDestination { /** *

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) - * where inventory results are published.

+ * where inventory results are published.

*/ S3BucketDestination: InventoryS3BucketDestination | undefined; } @@ -4791,7 +4791,7 @@ export namespace InventoryDestination { /** *

Specifies an inventory filter. The inventory only includes objects that meet the - * filter's criteria.

+ * filter's criteria.

*/ export interface InventoryFilter { /** @@ -4848,7 +4848,7 @@ export namespace InventorySchedule { /** *

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see - * GET Bucket inventory in the Amazon S3 API Reference. + * GET Bucket inventory in the Amazon S3 API Reference. *

*/ export interface InventoryConfiguration { @@ -4859,14 +4859,14 @@ export interface InventoryConfiguration { /** *

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.

+ * inventory list is generated. If set to False, no inventory list is + * generated.

*/ IsEnabled: boolean | undefined; /** *

Specifies an inventory filter. The inventory only includes objects that meet the - * filter's criteria.

+ * filter's criteria.

*/ Filter?: InventoryFilter; @@ -4877,10 +4877,10 @@ export interface InventoryConfiguration { /** *

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.

+ * 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.

*/ IncludedObjectVersions: InventoryIncludedObjectVersions | string | undefined; @@ -4956,20 +4956,20 @@ export namespace GetBucketInventoryConfigurationRequest { export interface LifecycleExpiration { /** *

Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 - * Format.

+ * Format.

*/ Date?: Date; /** *

Indicates the lifetime, in days, of the objects that are subject to the rule. The value - * must be a non-zero positive integer.

+ * must be a non-zero positive integer.

*/ Days?: number; /** *

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.

+ * 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.

*/ ExpiredObjectDeleteMarker?: boolean; } @@ -4985,8 +4985,8 @@ export namespace LifecycleExpiration { /** *

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more - * predicates. The Lifecycle Rule will apply to any object matching all of the predicates - * configured inside the And operator.

+ * predicates. The Lifecycle Rule will apply to any object matching all of the predicates + * configured inside the And operator.

*/ export interface LifecycleRuleAndOperator { /** @@ -4996,7 +4996,7 @@ export interface LifecycleRuleAndOperator { /** *

All of these tags must exist in the object's tag set in order for the rule to - * apply.

+ * apply.

*/ Tags?: Tag[]; } @@ -5012,8 +5012,8 @@ export namespace LifecycleRuleAndOperator { /** *

The Filter is used to identify objects that a Lifecycle Rule applies to. A - * Filter must have exactly one of Prefix, Tag, or - * And specified.

+ * Filter must have exactly one of Prefix, Tag, or + * And specified.

*/ export type LifecycleRuleFilter = | LifecycleRuleFilter.AndMember @@ -5024,11 +5024,11 @@ export type LifecycleRuleFilter = export namespace LifecycleRuleFilter { /** *

Prefix identifying one or more objects to which the rule applies.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ export interface PrefixMember { Prefix: string; @@ -5049,8 +5049,8 @@ export namespace LifecycleRuleFilter { /** *

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more - * predicates. The Lifecycle Rule will apply to any object matching all of the predicates - * configured inside the And operator.

+ * predicates. The Lifecycle Rule will apply to any object matching all of the predicates + * configured inside the And operator.

*/ export interface AndMember { Prefix?: never; @@ -5093,15 +5093,15 @@ export namespace LifecycleRuleFilter { /** *

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently - * deletes the noncurrent object versions. You set this lifecycle configuration action on a - * bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent - * object versions at a specific period in the object's lifetime.

+ * deletes the noncurrent object versions. You set this lifecycle configuration action on a + * bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent + * object versions at a specific period in the object's lifetime.

*/ export interface NoncurrentVersionExpiration { /** *

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 S3 User Guide.

+ * associated action. For information about the noncurrent days calculations, see How + * Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

*/ NoncurrentDays?: number; } @@ -5119,20 +5119,20 @@ export type TransitionStorageClass = "DEEP_ARCHIVE" | "GLACIER" | "INTELLIGENT_T /** *

Container for the transition rule that describes when noncurrent objects transition to - * the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, - * GLACIER, or DEEP_ARCHIVE 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 the STANDARD_IA, - * ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or - * DEEP_ARCHIVE storage class at a specific period in the object's - * lifetime.

+ * the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, + * GLACIER, or DEEP_ARCHIVE 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 the STANDARD_IA, + * ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or + * DEEP_ARCHIVE storage class at a specific period in the object's + * lifetime.

*/ export interface NoncurrentVersionTransition { /** *

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 S3 User Guide.

+ * associated action. For information about the noncurrent days calculations, see How + * Amazon S3 Calculates How Long an Object Has Been Noncurrent in the + * Amazon S3 User Guide.

*/ NoncurrentDays?: number; @@ -5155,19 +5155,19 @@ export type ExpirationStatus = "Disabled" | "Enabled"; /** *

Specifies when an object transitions to a specified storage class. For more information - * about Amazon S3 lifecycle configuration rules, see Transitioning - * Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

+ * about Amazon S3 lifecycle configuration rules, see Transitioning + * Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

*/ export interface Transition { /** *

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.

+ * must be in ISO 8601 format. The time is always midnight UTC.

*/ Date?: Date; /** *

Indicates the number of days after creation when objects are transitioned to the - * specified storage class. The value must be a positive integer.

+ * specified storage class. The value must be a positive integer.

*/ Days?: number; @@ -5192,7 +5192,7 @@ export namespace Transition { export interface LifecycleRule { /** *

Specifies the expiration for the lifecycle of the object in the form of date, days and, - * whether the object has a delete marker.

+ * whether the object has a delete marker.

*/ Expiration?: LifecycleExpiration; @@ -5205,26 +5205,26 @@ export interface LifecycleRule { * @deprecated * *

Prefix identifying one or more objects to which the rule applies. This is - * no longer used; use Filter instead.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * no longer used; use Filter instead.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ Prefix?: string; /** *

The Filter is used to identify objects that a Lifecycle Rule applies to. A - * Filter must have exactly one of Prefix, Tag, or - * And specified. Filter is required if the LifecycleRule - * does not containt a Prefix element.

+ * Filter must have exactly one of Prefix, Tag, or + * And specified. Filter is required if the LifecycleRule + * does not containt a Prefix element.

*/ Filter?: LifecycleRuleFilter; /** *

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not - * currently being applied.

+ * currently being applied.

*/ Status: ExpirationStatus | string | undefined; @@ -5235,26 +5235,26 @@ export interface LifecycleRule { /** *

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.

+ * 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.

*/ NoncurrentVersionTransitions?: NoncurrentVersionTransition[]; /** *

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently - * deletes the noncurrent object versions. You set this lifecycle configuration action on a - * bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent - * object versions at a specific period in the object's lifetime.

+ * deletes the noncurrent object versions. You set this lifecycle configuration action on a + * bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent + * object versions at a specific period in the object's lifetime.

*/ NoncurrentVersionExpiration?: NoncurrentVersionExpiration; /** *

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will - * wait before permanently removing all parts of the upload. For more information, see - * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the - * Amazon S3 User Guide.

+ * wait before permanently removing all parts of the upload. For more information, see + * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the + * Amazon S3 User Guide.

*/ AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload; } @@ -5310,9 +5310,9 @@ export namespace GetBucketLifecycleConfigurationRequest { export interface GetBucketLocationOutput { /** *

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported - * location constraints by Region, see Regions and Endpoints. - * Buckets in Region us-east-1 have a LocationConstraint of - * null.

+ * location constraints by Region, see Regions and Endpoints. + * Buckets in Region us-east-1 have a LocationConstraint of + * null.

*/ LocationConstraint?: BucketLocationConstraint | string; } @@ -5375,16 +5375,16 @@ export namespace TargetGrant { /** *

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys - * for a bucket. For more information, see PUT Bucket logging in the - * Amazon S3 API Reference.

+ * for a bucket. For more information, see PUT Bucket logging in the + * Amazon S3 API Reference.

*/ export interface LoggingEnabled { /** *

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.

+ * 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.

*/ TargetBucket: string | undefined; @@ -5395,8 +5395,8 @@ export interface LoggingEnabled { /** *

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.

+ * single bucket, you can use a prefix to distinguish which log files came from which + * bucket.

*/ TargetPrefix: string | undefined; } @@ -5413,8 +5413,8 @@ export namespace LoggingEnabled { export interface GetBucketLoggingOutput { /** *

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys - * for a bucket. For more information, see PUT Bucket logging in the - * Amazon S3 API Reference.

+ * for a bucket. For more information, see PUT Bucket logging in the + * Amazon S3 API Reference.

*/ LoggingEnabled?: LoggingEnabled; } @@ -5451,8 +5451,8 @@ export namespace GetBucketLoggingRequest { /** *

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.

+ * The operator must have at least two predicates, and an object must match all of the + * predicates in order for the filter to apply.

*/ export interface MetricsAndOperator { /** @@ -5477,8 +5477,8 @@ export namespace MetricsAndOperator { /** *

Specifies a metrics configuration filter. The metrics configuration only includes - * objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction - * (MetricsAndOperator).

+ * objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction + * (MetricsAndOperator).

*/ export type MetricsFilter = | MetricsFilter.AndMember @@ -5509,8 +5509,8 @@ export namespace MetricsFilter { /** *

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.

+ * The operator must have at least two predicates, and an object must match all of the + * predicates in order for the filter to apply.

*/ export interface AndMember { Prefix?: never; @@ -5553,11 +5553,11 @@ export namespace MetricsFilter { /** *

Specifies a metrics configuration for the CloudWatch request metrics (specified by the - * metrics configuration ID) from an Amazon S3 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. For more information, - * see PUT Bucket - * metrics in the Amazon S3 API Reference.

+ * metrics configuration ID) from an Amazon S3 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. For more information, + * see PUT Bucket + * metrics in the Amazon S3 API Reference.

*/ export interface MetricsConfiguration { /** @@ -5567,8 +5567,8 @@ export interface MetricsConfiguration { /** *

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).

+ * objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction + * (MetricsAndOperator).

*/ Filter?: MetricsFilter; } @@ -5672,14 +5672,14 @@ export type FilterRuleName = "prefix" | "suffix"; /** *

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or - * prefix of the key name.

+ * prefix of the key name.

*/ export interface FilterRule { /** *

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 S3 User Guide.

+ * 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 S3 User Guide.

*/ Name?: FilterRuleName | string; @@ -5704,7 +5704,7 @@ export namespace FilterRule { export interface S3KeyFilter { /** *

A list of containers for the key-value pair that defines the criteria for the filter - * rule.

+ * rule.

*/ FilterRules?: FilterRule[]; } @@ -5720,8 +5720,8 @@ export namespace S3KeyFilter { /** *

Specifies object key name filtering rules. For information about key name filtering, see - * Configuring - * Event Notifications in the Amazon S3 User Guide.

+ * Configuring + * Event Notifications in the Amazon S3 User Guide.

*/ export interface NotificationConfigurationFilter { /** @@ -5745,27 +5745,27 @@ export namespace NotificationConfigurationFilter { export interface LambdaFunctionConfiguration { /** *

An optional unique identifier for configurations in a notification configuration. If you - * don't provide one, Amazon S3 will assign an ID.

+ * don't provide one, Amazon S3 will assign an ID.

*/ Id?: string; /** *

The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the - * specified event type occurs.

+ * specified event type occurs.

*/ LambdaFunctionArn: string | undefined; /** *

The Amazon S3 bucket event for which to invoke the Lambda function. For more information, - * see Supported - * Event Types in the Amazon S3 User Guide.

+ * see Supported + * Event Types in the Amazon S3 User Guide.

*/ Events: (Event | string)[] | undefined; /** *

Specifies object key name filtering rules. For information about key name filtering, see - * Configuring - * Event Notifications in the Amazon S3 User Guide.

+ * Configuring + * Event Notifications in the Amazon S3 User Guide.

*/ Filter?: NotificationConfigurationFilter; } @@ -5781,18 +5781,18 @@ export namespace LambdaFunctionConfiguration { /** *

Specifies the configuration for publishing messages to an Amazon Simple Queue Service - * (Amazon SQS) queue when Amazon S3 detects specified events.

+ * (Amazon SQS) queue when Amazon S3 detects specified events.

*/ export interface QueueConfiguration { /** *

An optional unique identifier for configurations in a notification configuration. If you - * don't provide one, Amazon S3 will assign an ID.

+ * don't provide one, Amazon S3 will assign an ID.

*/ Id?: string; /** *

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.

+ * when it detects events of the specified type.

*/ QueueArn: string | undefined; @@ -5803,8 +5803,8 @@ export interface QueueConfiguration { /** *

Specifies object key name filtering rules. For information about key name filtering, see - * Configuring - * Event Notifications in the Amazon S3 User Guide.

+ * Configuring + * Event Notifications in the Amazon S3 User Guide.

*/ Filter?: NotificationConfigurationFilter; } @@ -5820,32 +5820,32 @@ export namespace QueueConfiguration { /** *

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.

+ * Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

*/ export interface TopicConfiguration { /** *

An optional unique identifier for configurations in a notification configuration. If you - * don't provide one, Amazon S3 will assign an ID.

+ * don't provide one, Amazon S3 will assign an ID.

*/ Id?: string; /** *

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.

+ * when it detects events of the specified type.

*/ TopicArn: string | undefined; /** *

The Amazon S3 bucket event about which to send notifications. For more information, see - * Supported - * Event Types in the Amazon S3 User Guide.

+ * Supported + * Event Types in the Amazon S3 User Guide.

*/ Events: (Event | string)[] | undefined; /** *

Specifies object key name filtering rules. For information about key name filtering, see - * Configuring - * Event Notifications in the Amazon S3 User Guide.

+ * Configuring + * Event Notifications in the Amazon S3 User Guide.

*/ Filter?: NotificationConfigurationFilter; } @@ -5861,24 +5861,24 @@ export namespace TopicConfiguration { /** *

A container for specifying the notification configuration of the bucket. If this element - * is empty, notifications are turned off for the bucket.

+ * is empty, notifications are turned off for the bucket.

*/ export interface NotificationConfiguration { /** *

The topic to which notifications are sent and the events for which notifications are - * generated.

+ * generated.

*/ TopicConfigurations?: TopicConfiguration[]; /** *

The Amazon Simple Queue Service queues to publish messages to and the events for which - * to publish messages.

+ * to publish messages.

*/ QueueConfigurations?: QueueConfiguration[]; /** *

Describes the Lambda functions to invoke and the events for which to invoke - * them.

+ * them.

*/ LambdaFunctionConfigurations?: LambdaFunctionConfiguration[]; } @@ -5900,11 +5900,11 @@ export type ObjectOwnership = "BucketOwnerPreferred" | "ObjectWriter"; export interface OwnershipControlsRule { /** *

The container element for object ownership for a bucket's ownership controls.

- *

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket - * owner if the objects are uploaded with the bucket-owner-full-control canned - * ACL.

- *

ObjectWriter - The uploading account will own the object if the object is uploaded with - * the bucket-owner-full-control canned ACL.

+ *

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket + * owner if the objects are uploaded with the bucket-owner-full-control canned + * ACL.

+ *

ObjectWriter - The uploading account will own the object if the object is uploaded with + * the bucket-owner-full-control canned ACL.

*/ ObjectOwnership: ObjectOwnership | string | undefined; } @@ -5940,7 +5940,7 @@ export namespace OwnershipControls { export interface GetBucketOwnershipControlsOutput { /** *

The OwnershipControls (BucketOwnerPreferred or ObjectWriter) currently in - * effect for this Amazon S3 bucket.

+ * effect for this Amazon S3 bucket.

*/ OwnershipControls?: OwnershipControls; } @@ -6019,7 +6019,7 @@ export namespace GetBucketPolicyRequest { export interface PolicyStatus { /** *

The policy status for this bucket. TRUE indicates that this bucket is - * public. FALSE indicates that the bucket is not public.

+ * public. FALSE indicates that the bucket is not public.

*/ IsPublic?: boolean; } @@ -6074,24 +6074,24 @@ export type DeleteMarkerReplicationStatus = "Disabled" | "Enabled"; /** *

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter - * in your replication configuration, you must also include a - * DeleteMarkerReplication element. If your Filter includes a - * Tag element, the DeleteMarkerReplication - * Status must be set to Disabled, because Amazon S3 does not support replicating - * delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

- *

For more information about delete marker replication, see Basic Rule - * Configuration.

- * - *

If you are using an earlier version of the replication configuration, Amazon S3 handles - * replication of delete markers differently. For more information, see Backward Compatibility.

- * + * in your replication configuration, you must also include a + * DeleteMarkerReplication element. If your Filter includes a + * Tag element, the DeleteMarkerReplication + * Status must be set to Disabled, because Amazon S3 does not support replicating + * delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

+ *

For more information about delete marker replication, see Basic Rule + * Configuration.

+ * + *

If you are using an earlier version of the replication configuration, Amazon S3 handles + * replication of delete markers differently. For more information, see Backward Compatibility.

+ * */ export interface DeleteMarkerReplication { /** *

Indicates whether to replicate delete markers.

- * - *

Indicates whether to replicate delete markers.

- * + * + *

Indicates whether to replicate delete markers.

+ * */ Status?: DeleteMarkerReplicationStatus | string; } @@ -6107,15 +6107,15 @@ export namespace DeleteMarkerReplication { /** *

Specifies encryption-related information for an Amazon S3 bucket that is a destination for - * replicated objects.

+ * replicated objects.

*/ export interface EncryptionConfiguration { /** *

Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key - * stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses - * this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys. - * For more information, see Using symmetric and - * asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

+ * stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses + * this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys. + * For more information, see Using symmetric and + * asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

*/ ReplicaKmsKeyID?: string; } @@ -6131,12 +6131,12 @@ export namespace EncryptionConfiguration { /** *

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics - * EventThreshold.

+ * EventThreshold.

*/ export interface ReplicationTimeValue { /** *

Contains an integer specifying time in minutes.

- *

Valid value: 15

+ *

Valid value: 15

*/ Minutes?: number; } @@ -6154,7 +6154,7 @@ export type MetricsStatus = "Disabled" | "Enabled"; /** *

A container specifying replication metrics-related settings enabling replication - * metrics and events.

+ * metrics and events.

*/ export interface Metrics { /** @@ -6164,7 +6164,7 @@ export interface Metrics { /** *

A container specifying the time threshold for emitting the - * s3:Replication:OperationMissedThreshold event.

+ * s3:Replication:OperationMissedThreshold event.

*/ EventThreshold?: ReplicationTimeValue; } @@ -6182,8 +6182,8 @@ export type ReplicationTimeStatus = "Disabled" | "Enabled"; /** *

A container specifying S3 Replication Time Control (S3 RTC) related information, 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.

+ * enabled and the time when all objects and operations on objects must be replicated. Must be + * specified together with a Metrics block.

*/ export interface ReplicationTime { /** @@ -6193,7 +6193,7 @@ export interface ReplicationTime { /** *

A container specifying the time by which replication should be complete for all objects - * and operations on objects.

+ * and operations on objects.

*/ Time: ReplicationTimeValue | undefined; } @@ -6209,7 +6209,7 @@ export namespace ReplicationTime { /** *

Specifies information about where to publish analysis or configuration results for an - * Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

+ * Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

*/ export interface Destination { /** @@ -6219,46 +6219,46 @@ export interface Destination { /** *

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to - * change replica ownership to the Amazon Web Services 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 S3 User Guide.

+ * change replica ownership to the Amazon Web Services 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 S3 User Guide.

*/ Account?: string; /** *

The storage class to use when replicating objects, such as S3 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 S3 API Reference.

+ * 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 S3 API Reference.

*/ StorageClass?: StorageClass | string; /** *

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 Amazon Web Services account that - * owns the destination bucket. If this is not specified in the replication configuration, the - * replicas are owned by same Amazon Web Services account that owns the source object.

+ * owners are not the same), and you want to change replica ownership to the Amazon Web Services account that + * owns the destination bucket. If this is not specified in the replication configuration, the + * replicas are owned by same Amazon Web Services account that owns the source object.

*/ AccessControlTranslation?: AccessControlTranslation; /** *

A container that provides information about encryption. If - * SourceSelectionCriteria is specified, you must specify this element.

+ * SourceSelectionCriteria is specified, you must specify this element.

*/ EncryptionConfiguration?: EncryptionConfiguration; /** *

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.

+ * when all objects and operations on objects must be replicated. Must be specified together + * with a Metrics block.

*/ ReplicationTime?: ReplicationTime; /** *

A container specifying replication metrics-related settings enabling replication - * metrics and events.

+ * metrics and events.

*/ Metrics?: Metrics; } @@ -6276,7 +6276,7 @@ export type ExistingObjectReplicationStatus = "Disabled" | "Enabled"; /** *

Optional configuration to replicate existing source bucket objects. For more - * information, see Replicating Existing Objects in the Amazon S3 User Guide. + * information, see Replicating Existing Objects in the Amazon S3 User Guide. *

*/ export interface ExistingObjectReplication { @@ -6297,23 +6297,23 @@ export namespace ExistingObjectReplication { /** *

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.

    - *
    • - *
+ * 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.

    + *
    • + *
*/ export interface ReplicationRuleAndOperator { /** *

An object key name prefix that identifies the subset of objects to which the rule - * applies.

+ * applies.

*/ Prefix?: string; @@ -6334,8 +6334,8 @@ export namespace ReplicationRuleAndOperator { /** *

A filter that identifies the subset of objects to which the replication rule applies. A - * Filter must specify exactly one Prefix, Tag, or - * an And child element.

+ * Filter must specify exactly one Prefix, Tag, or + * an And child element.

*/ export type ReplicationRuleFilter = | ReplicationRuleFilter.AndMember @@ -6346,12 +6346,12 @@ export type ReplicationRuleFilter = export namespace ReplicationRuleFilter { /** *

An object key name prefix that identifies the subset of objects to which the rule - * applies.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * applies.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ export interface PrefixMember { Prefix: string; @@ -6362,7 +6362,7 @@ export namespace ReplicationRuleFilter { /** *

A container for specifying a tag key and value.

- *

The rule applies only to objects that have the tag in their tag set.

+ *

The rule applies only to objects that have the tag in their tag set.

*/ export interface TagMember { Prefix?: never; @@ -6373,18 +6373,18 @@ export namespace ReplicationRuleFilter { /** *

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.

    - *
    • - *
+ * 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.

    + *
    • + *
*/ export interface AndMember { Prefix?: never; @@ -6429,14 +6429,14 @@ export type ReplicaModificationsStatus = "Disabled" | "Enabled"; /** *

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't - * replicate replica modifications by default. In the latest version of replication - * configuration (when Filter is specified), you can specify this element and set - * the status to Enabled to replicate modifications on replicas.

- * - *

If you don't specify the Filter element, Amazon S3 assumes that the - * replication configuration is the earlier version, V1. In the earlier version, this - * element is not allowed.

- * + * replicate replica modifications by default. In the latest version of replication + * configuration (when Filter is specified), you can specify this element and set + * the status to Enabled to replicate modifications on replicas.

+ * + *

If you don't specify the Filter element, Amazon S3 assumes that the + * replication configuration is the earlier version, V1. In the earlier version, this + * element is not allowed.

+ * */ export interface ReplicaModifications { /** @@ -6458,12 +6458,12 @@ export type SseKmsEncryptedObjectsStatus = "Disabled" | "Enabled"; /** *

A container for filter information for the selection of S3 objects encrypted with Amazon Web Services - * KMS.

+ * KMS.

*/ export interface SseKmsEncryptedObjects { /** *

Specifies whether Amazon S3 replicates objects created with server-side encryption using an - * Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

+ * Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

*/ Status: SseKmsEncryptedObjectsStatus | string | undefined; } @@ -6479,29 +6479,29 @@ export namespace SseKmsEncryptedObjects { /** *

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 Amazon Web Services Key Management - * Service (SSE-KMS).

+ * 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 Amazon Web Services Key Management + * Service (SSE-KMS).

*/ export interface SourceSelectionCriteria { /** *

A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services - * KMS. If you include SourceSelectionCriteria in the replication configuration, - * this element is required.

+ * KMS. If you include SourceSelectionCriteria in the replication configuration, + * this element is required.

*/ SseKmsEncryptedObjects?: SseKmsEncryptedObjects; /** *

A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't - * replicate replica modifications by default. In the latest version of replication - * configuration (when Filter is specified), you can specify this element and set - * the status to Enabled to replicate modifications on replicas.

- * - *

If you don't specify the Filter element, Amazon S3 assumes that the - * replication configuration is the earlier version, V1. In the earlier version, this - * element is not allowed

- * + * replicate replica modifications by default. In the latest version of replication + * configuration (when Filter is specified), you can specify this element and set + * the status to Enabled to replicate modifications on replicas.

+ * + *

If you don't specify the Filter element, Amazon S3 assumes that the + * replication configuration is the earlier version, V1. In the earlier version, this + * element is not allowed

+ * */ ReplicaModifications?: ReplicaModifications; } @@ -6528,12 +6528,12 @@ export interface ReplicationRule { /** *

The priority indicates which rule has precedence whenever two or more replication rules - * conflict. Amazon S3 will attempt to replicate objects according to all replication rules. - * However, if there are two or more rules with the same destination bucket, then objects will - * be replicated according to the rule with the highest priority. The higher the number, the - * higher the priority.

- *

For more information, see Replication in the - * Amazon S3 User Guide.

+ * conflict. Amazon S3 will attempt to replicate objects according to all replication rules. + * However, if there are two or more rules with the same destination bucket, then objects will + * be replicated according to the rule with the highest priority. The higher the number, the + * higher the priority.

+ *

For more information, see Replication in the + * Amazon S3 User Guide.

*/ Priority?: number; @@ -6541,20 +6541,20 @@ export interface ReplicationRule { * @deprecated * *

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.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, + * specify an empty string.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ Prefix?: string; /** *

A filter that identifies the subset of objects to which the replication rule applies. A - * Filter must specify exactly one Prefix, Tag, or - * an And child element.

+ * Filter must specify exactly one Prefix, Tag, or + * an And child element.

*/ Filter?: ReplicationRuleFilter; @@ -6565,10 +6565,10 @@ export interface ReplicationRule { /** *

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 Amazon Web Services Key Management - * Service (SSE-KMS).

+ * 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 Amazon Web Services Key Management + * Service (SSE-KMS).

*/ SourceSelectionCriteria?: SourceSelectionCriteria; @@ -6579,23 +6579,23 @@ export interface ReplicationRule { /** *

A container for information about the replication destination and its configurations - * including enabling the S3 Replication Time Control (S3 RTC).

+ * including enabling the S3 Replication Time Control (S3 RTC).

*/ Destination: Destination | undefined; /** *

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter - * in your replication configuration, you must also include a - * DeleteMarkerReplication element. If your Filter includes a - * Tag element, the DeleteMarkerReplication - * Status must be set to Disabled, because Amazon S3 does not support replicating - * delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

- *

For more information about delete marker replication, see Basic Rule - * Configuration.

- * - *

If you are using an earlier version of the replication configuration, Amazon S3 handles - * replication of delete markers differently. For more information, see Backward Compatibility.

- * + * in your replication configuration, you must also include a + * DeleteMarkerReplication element. If your Filter includes a + * Tag element, the DeleteMarkerReplication + * Status must be set to Disabled, because Amazon S3 does not support replicating + * delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

+ *

For more information about delete marker replication, see Basic Rule + * Configuration.

+ * + *

If you are using an earlier version of the replication configuration, Amazon S3 handles + * replication of delete markers differently. For more information, see Backward Compatibility.

+ * */ DeleteMarkerReplication?: DeleteMarkerReplication; } @@ -6612,19 +6612,19 @@ export namespace ReplicationRule { /** *

A container for replication rules. You can add up to 1,000 rules. The maximum size of a - * replication configuration is 2 MB.

+ * replication configuration is 2 MB.

*/ export interface ReplicationConfiguration { /** *

The Amazon Resource Name (ARN) of the 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 S3 User Guide.

+ * Amazon S3 assumes when replicating objects. For more information, see How to Set Up + * Replication in the Amazon S3 User Guide.

*/ Role: string | undefined; /** *

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.

+ * least one rule and can contain a maximum of 1,000 rules.

*/ Rules: ReplicationRule[] | undefined; } @@ -6642,7 +6642,7 @@ export namespace ReplicationConfiguration { export interface GetBucketReplicationOutput { /** *

A container for replication rules. You can add up to 1,000 rules. The maximum size of a - * replication configuration is 2 MB.

+ * replication configuration is 2 MB.

*/ ReplicationConfiguration?: ReplicationConfiguration; } @@ -6768,8 +6768,8 @@ export interface GetBucketVersioningOutput { /** *

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.

+ * 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.

*/ MFADelete?: MFADeleteStatus | string; } @@ -6810,11 +6810,11 @@ export namespace GetBucketVersioningRequest { export interface ErrorDocument { /** *

The object key name to use when a 4XX class error occurs.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ Key: string | undefined; } @@ -6834,14 +6834,14 @@ export namespace ErrorDocument { export interface IndexDocument { /** *

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.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * (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.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ Suffix: string | undefined; } @@ -6859,7 +6859,7 @@ export type Protocol = "http" | "https"; /** *

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 - * bucket.

+ * bucket.

*/ export interface RedirectAllRequestsTo { /** @@ -6869,7 +6869,7 @@ export interface RedirectAllRequestsTo { /** *

Protocol to use when redirecting requests. The default is the protocol that is used in - * the original request.

+ * the original request.

*/ Protocol?: Protocol | string; } @@ -6885,34 +6885,34 @@ export namespace RedirectAllRequestsTo { /** *

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.

+ * 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.

*/ export interface Condition { /** *

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.

+ * 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.

*/ HttpErrorCodeReturnedEquals?: string; /** *

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.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * 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.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ KeyPrefixEquals?: string; } @@ -6928,7 +6928,7 @@ export namespace Condition { /** *

Specifies how requests are redirected. In the event of an error, you can specify a - * different error code to return.

+ * different error code to return.

*/ export interface Redirect { /** @@ -6938,40 +6938,40 @@ export interface Redirect { /** *

The HTTP redirect code to use on the response. Not required if one of the siblings is - * present.

+ * present.

*/ HttpRedirectCode?: string; /** *

Protocol to use when redirecting requests. The default is the protocol that is used in - * the original request.

+ * the original request.

*/ Protocol?: Protocol | string; /** *

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.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * 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.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ ReplaceKeyPrefixWith?: string; /** *

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.

- * - *

Replacement must be made for object keys containing special characters (such as carriage returns) when using - * XML requests. For more information, see - * XML related object key constraints.

- * + * error.html. Not required if one of the siblings is present. Can be present + * only if ReplaceKeyPrefixWith is not provided.

+ * + *

Replacement must be made for object keys containing special characters (such as carriage returns) when using + * XML requests. For more information, see + * XML related object key constraints.

+ * */ ReplaceKeyWith?: string; } @@ -6987,22 +6987,22 @@ export namespace Redirect { /** *

Specifies the redirect behavior and when a redirect is applied. For more information - * about routing rules, see Configuring advanced conditional redirects in the - * Amazon S3 User Guide.

+ * about routing rules, see Configuring advanced conditional redirects in the + * Amazon S3 User Guide.

*/ export interface RoutingRule { /** *

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.

+ * 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.

*/ Condition?: Condition; /** *

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.

+ * another page, or with another protocol. In the event of an error, you can specify a + * different error code to return.

*/ Redirect: Redirect | undefined; } @@ -7019,13 +7019,13 @@ export namespace RoutingRule { export interface GetBucketWebsiteOutput { /** *

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 - * bucket.

+ * bucket.

*/ RedirectAllRequestsTo?: RedirectAllRequestsTo; /** *

The name of the index document for the website (for example - * index.html).

+ * index.html).

*/ IndexDocument?: IndexDocument; @@ -7080,7 +7080,7 @@ export interface GetObjectOutput { /** *

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.

+ * false, this response header does not appear in the response.

*/ DeleteMarker?: boolean; @@ -7091,14 +7091,14 @@ export interface GetObjectOutput { /** *

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.

+ * 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.

*/ Expiration?: string; /** *

Provides information about object restoration action and expiration time of the - * restored object copy.

+ * restored object copy.

*/ Restore?: string; @@ -7114,15 +7114,15 @@ export interface GetObjectOutput { /** *

An ETag is an opaque identifier assigned by a web server to a specific version of a - * resource found at a URL.

+ * resource found at a URL.

*/ ETag?: string; /** *

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.

+ * headers. This can happen if you create metadata using an API like SOAP that supports more + * flexible metadata than the REST API. For example, using SOAP, you can create metadata whose + * values are not legal HTTP headers.

*/ MissingMeta?: number; @@ -7143,8 +7143,8 @@ export interface GetObjectOutput { /** *

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.

+ * mechanisms must be applied to obtain the media-type referenced by the Content-Type header + * field.

*/ ContentEncoding?: string; @@ -7170,14 +7170,14 @@ export interface GetObjectOutput { /** *

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.

+ * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in + * the object metadata.

*/ WebsiteRedirectLocation?: string; /** *

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

+ * AES256, aws:kms).

*/ ServerSideEncryption?: ServerSideEncryption | string; @@ -7188,20 +7188,20 @@ export interface GetObjectOutput { /** *

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

+ * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

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

+ * response will include this header to provide round-trip message integrity verification of + * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed customer master key (CMK) that was used for the object.

+ * customer managed customer master key (CMK) that was used for the object.

*/ SSEKMSKeyId?: string; @@ -7212,19 +7212,19 @@ export interface GetObjectOutput { /** *

Provides storage class information of the object. Amazon S3 returns this header for all - * objects except for S3 Standard storage class objects.

+ * objects except for S3 Standard storage class objects.

*/ StorageClass?: StorageClass | string; /** *

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

+ * request.

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

Amazon S3 can return this if your request involves a bucket that is either a source or - * destination in a replication rule.

+ * destination in a replication rule.

*/ ReplicationStatus?: ReplicationStatus | string; @@ -7250,7 +7250,7 @@ export interface GetObjectOutput { /** *

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.

+ * you have permission to view an object's legal hold status.

*/ ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string; } @@ -7268,32 +7268,32 @@ export namespace GetObjectOutput { export interface GetObjectRequest { /** *

The bucket name containing the object.

- *

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

- *

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

+ *

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

+ *

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

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

Return the object only if its entity tag (ETag) is the same as the one specified, - * otherwise return a 412 (precondition failed).

+ * otherwise return a 412 (precondition failed).

*/ IfMatch?: string; /** *

Return the object only if it has been modified since the specified time, otherwise - * return a 304 (not modified).

+ * return a 304 (not modified).

*/ IfModifiedSince?: Date; /** *

Return the object only if its entity tag (ETag) is different from the one specified, - * otherwise return a 304 (not modified).

+ * otherwise return a 304 (not modified).

*/ IfNoneMatch?: string; /** *

Return the object only if it has not been modified since the specified time, otherwise - * return a 412 (precondition failed).

+ * return a 412 (precondition failed).

*/ IfUnmodifiedSince?: Date; @@ -7304,11 +7304,11 @@ export interface GetObjectRequest { /** *

Downloads the specified range bytes of an object. For more information about the HTTP - * Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

- * - *

Amazon S3 doesn't support retrieving multiple ranges of data per GET - * request.

- * + * Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

+ * + *

Amazon S3 doesn't support retrieving multiple ranges of data per GET + * request.

+ * */ Range?: string; @@ -7349,37 +7349,37 @@ export interface GetObjectRequest { /** *

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

+ * AES256).

*/ SSECustomerAlgorithm?: string; /** *

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This - * value is used to decrypt the object when recovering it and must match the one used when - * storing the data. The key must be appropriate for use with the algorithm specified in the - * x-amz-server-side-encryption-customer-algorithm header.

+ * value is used to decrypt the object when recovering it and must match the one used when + * storing the data. The key must be appropriate for use with the algorithm specified in the + * x-amz-server-side-encryption-customer-algorithm header.

*/ SSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ SSECustomerKeyMD5?: string; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

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

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.

+ * Effectively performs a 'ranged' GET request for the part specified. Useful for downloading + * just a part of an object.

*/ PartNumber?: number; @@ -7448,7 +7448,7 @@ export interface GetObjectAclOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -7465,7 +7465,7 @@ export namespace GetObjectAclOutput { export interface GetObjectAclRequest { /** *

The bucket name that contains the object for which to get the ACL information.

- *

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

+ *

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

*/ Bucket: string | undefined; @@ -7481,9 +7481,9 @@ export interface GetObjectAclRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -7540,7 +7540,7 @@ export namespace GetObjectLegalHoldOutput { export interface GetObjectLegalHoldRequest { /** *

The bucket name containing the object whose Legal Hold status you want to retrieve.

- *

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

+ *

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

*/ Bucket: string | undefined; @@ -7556,9 +7556,9 @@ export interface GetObjectLegalHoldRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -7583,37 +7583,37 @@ export type ObjectLockRetentionMode = "COMPLIANCE" | "GOVERNANCE"; /** *

The container element for specifying the default Object Lock retention settings for new - * objects placed in the specified bucket.

- * - *
    - *
  • - *

    The DefaultRetention settings require both a mode and a - * period.

    - *
    • - *
  • - *

    The DefaultRetention period can be either Days - * or Years but you must select one. You cannot specify Days - * and Years at the same time.

    - *
    • - *
- * + * objects placed in the specified bucket.

+ * + *
    + *
  • + *

    The DefaultRetention settings require both a mode and a + * period.

    + *
    • + *
  • + *

    The DefaultRetention period can be either Days + * or Years but you must select one. You cannot specify Days + * and Years at the same time.

    + *
    • + *
+ * */ export interface DefaultRetention { /** *

The default Object Lock retention mode you want to apply to new objects placed in the - * specified bucket. Must be used with either Days or Years.

+ * specified bucket. Must be used with either Days or Years.

*/ Mode?: ObjectLockRetentionMode | string; /** *

The number of days that you want to specify for the default retention period. Must be - * used with Mode.

+ * used with Mode.

*/ Days?: number; /** *

The number of years that you want to specify for the default retention period. Must be - * used with Mode.

+ * used with Mode.

*/ Years?: number; } @@ -7633,9 +7633,9 @@ export namespace DefaultRetention { export interface ObjectLockRule { /** *

The default Object Lock retention mode and period that you want to apply to new objects - * placed in the specified bucket. Bucket settings require both a mode and a period. - * The period can be either Days or Years but you must select one. - * You cannot specify Days and Years at the same time.

+ * placed in the specified bucket. Bucket settings require both a mode and a period. + * The period can be either Days or Years but you must select one. + * You cannot specify Days and Years at the same time.

*/ DefaultRetention?: DefaultRetention; } @@ -7655,16 +7655,16 @@ export namespace ObjectLockRule { export interface ObjectLockConfiguration { /** *

Indicates whether this bucket has an Object Lock configuration enabled. - * Enable ObjectLockEnabled when you apply ObjectLockConfiguration - * to a bucket.

+ * Enable ObjectLockEnabled when you apply ObjectLockConfiguration + * to a bucket.

*/ ObjectLockEnabled?: ObjectLockEnabled | string; /** *

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply - * ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. - * The period can be either Days or Years but you must select one. - * You cannot specify Days and Years at the same time.

+ * ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. + * The period can be either Days or Years but you must select one. + * You cannot specify Days and Years at the same time.

*/ Rule?: ObjectLockRule; } @@ -7697,7 +7697,7 @@ export namespace GetObjectLockConfigurationOutput { export interface GetObjectLockConfigurationRequest { /** *

The bucket whose Object Lock configuration you want to retrieve.

- *

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

+ *

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

*/ Bucket: string | undefined; @@ -7759,7 +7759,7 @@ export namespace GetObjectRetentionOutput { export interface GetObjectRetentionRequest { /** *

The bucket name containing the object whose retention settings you want to retrieve.

- *

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

+ *

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

*/ Bucket: string | undefined; @@ -7775,9 +7775,9 @@ export interface GetObjectRetentionRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -7820,8 +7820,8 @@ export namespace GetObjectTaggingOutput { export interface GetObjectTaggingRequest { /** *

The bucket name containing the object for which to get the tagging information.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -7842,9 +7842,9 @@ export interface GetObjectTaggingRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; } @@ -7866,7 +7866,7 @@ export interface GetObjectTorrentOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -7893,9 +7893,9 @@ export interface GetObjectTorrentRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -7916,55 +7916,55 @@ export namespace GetObjectTorrentRequest { /** *

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

+ * enable the configuration options in any combination. For more information about when Amazon S3 + * considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

*/ export interface PublicAccessBlockConfiguration { /** *

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.

+ * 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.

*/ BlockPublicAcls?: boolean; /** *

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.

+ * 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.

*/ IgnorePublicAcls?: boolean; /** *

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.

+ * 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.

*/ BlockPublicPolicy?: boolean; /** *

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting - * this element to TRUE restricts access to this bucket to only Amazon Web Service - * principals 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.

+ * this element to TRUE restricts access to this bucket to only Amazon Web Service + * principals 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.

*/ RestrictPublicBuckets?: boolean; } @@ -7981,7 +7981,7 @@ export namespace PublicAccessBlockConfiguration { export interface GetPublicAccessBlockOutput { /** *

The PublicAccessBlock configuration currently in effect for this Amazon S3 - * bucket.

+ * bucket.

*/ PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration; } @@ -7998,7 +7998,7 @@ export namespace GetPublicAccessBlockOutput { export interface GetPublicAccessBlockRequest { /** *

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

+ * to retrieve.

*/ Bucket: string | undefined; @@ -8020,8 +8020,8 @@ export namespace GetPublicAccessBlockRequest { export interface HeadBucketRequest { /** *

The bucket name.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -8062,7 +8062,7 @@ export type ArchiveStatus = "ARCHIVE_ACCESS" | "DEEP_ARCHIVE_ACCESS"; export interface HeadObjectOutput { /** *

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.

+ * false, this response header does not appear in the response.

*/ DeleteMarker?: boolean; @@ -8073,27 +8073,27 @@ export interface HeadObjectOutput { /** *

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.

+ * 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.

*/ Expiration?: string; /** *

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.

+ * 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:

+ *

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, 21 Dec 2012 00:00:00 - * GMT" - *

+ *

+ * x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 + * GMT" + *

* - *

If the object restoration is in progress, the header returns the value - * ongoing-request="true".

+ *

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.

+ *

For more information about archiving objects, see Transitioning Objects: General Considerations.

*/ Restore?: string; @@ -8114,15 +8114,15 @@ export interface HeadObjectOutput { /** *

An ETag is an opaque identifier assigned by a web server to a specific version of a - * resource found at a URL.

+ * resource found at a URL.

*/ ETag?: string; /** *

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.

+ * headers. This can happen if you create metadata using an API like SOAP that supports more + * flexible metadata than the REST API. For example, using SOAP, you can create metadata whose + * values are not legal HTTP headers.

*/ MissingMeta?: number; @@ -8143,8 +8143,8 @@ export interface HeadObjectOutput { /** *

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.

+ * mechanisms must be applied to obtain the media-type referenced by the Content-Type header + * field.

*/ ContentEncoding?: string; @@ -8165,16 +8165,16 @@ export interface HeadObjectOutput { /** *

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.

+ * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in + * the object metadata.

*/ WebsiteRedirectLocation?: string; /** *

If the object is stored using server-side encryption either with an Amazon Web Services 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).

+ * 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).

*/ ServerSideEncryption?: ServerSideEncryption | string; @@ -8185,20 +8185,20 @@ export interface HeadObjectOutput { /** *

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

+ * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

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

+ * response will include this header to provide round-trip message integrity verification of + * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed customer master key (CMK) that was used for the object.

+ * customer managed customer master key (CMK) that was used for the object.

*/ SSEKMSKeyId?: string; @@ -8209,58 +8209,58 @@ export interface HeadObjectOutput { /** *

Provides storage class information of the object. Amazon S3 returns this header for all - * objects except for S3 Standard storage class objects.

+ * objects except for S3 Standard storage class objects.

* - *

For more information, see Storage - * Classes.

+ *

For more information, see Storage + * Classes.

*/ StorageClass?: StorageClass | string; /** *

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

+ * request.

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

Amazon S3 can return this header if your request involves a bucket that is either a source or - * a destination in a replication rule.

+ * a destination in a replication rule.

* - *

In replication, you have a source bucket on which you configure replication and - * destination bucket or buckets 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 a 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 and there is no replica modification - * replication in progress.

    - *
    • - *
  • - *

    When replicating objects to multiple destination buckets the - * x-amz-replication-status header acts differently. The header of the - * source object will only return a value of COMPLETED when replication is successful to - * all destinations. The header will remain at value PENDING until replication has - * completed for all destinations. If one or more destinations fails replication the - * header will return FAILED.

    - *
    • - *
+ *

In replication, you have a source bucket on which you configure replication and + * destination bucket or buckets 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 a 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 and there is no replica modification + * replication in progress.

    + *
    • + *
  • + *

    When replicating objects to multiple destination buckets the + * x-amz-replication-status header acts differently. The header of the + * source object will only return a value of COMPLETED when replication is successful to + * all destinations. The header will remain at value PENDING until replication has + * completed for all destinations. If one or more destinations fails replication the + * header will return FAILED.

    + *
    • + *
* - *

For more information, see Replication.

+ *

For more information, see Replication.

*/ ReplicationStatus?: ReplicationStatus | string; @@ -8271,23 +8271,23 @@ export interface HeadObjectOutput { /** *

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.

+ * returned if the requester has the s3:GetObjectRetention permission. For more + * information about S3 Object Lock, see Object + * Lock.

*/ ObjectLockMode?: ObjectLockMode | string; /** *

The date and time when the Object Lock retention period expires. This header is only - * returned if the requester has the s3:GetObjectRetention permission.

+ * returned if the requester has the s3:GetObjectRetention permission.

*/ ObjectLockRetainUntilDate?: Date; /** *

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.

+ * 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.

*/ ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string; } @@ -8305,32 +8305,32 @@ export namespace HeadObjectOutput { export interface HeadObjectRequest { /** *

The name of the bucket containing the object.

- *

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

- *

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

+ *

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

+ *

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

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

Return the object only if its entity tag (ETag) is the same as the one specified, - * otherwise return a 412 (precondition failed).

+ * otherwise return a 412 (precondition failed).

*/ IfMatch?: string; /** *

Return the object only if it has been modified since the specified time, otherwise - * return a 304 (not modified).

+ * return a 304 (not modified).

*/ IfModifiedSince?: Date; /** *

Return the object only if its entity tag (ETag) is different from the one specified, - * otherwise return a 304 (not modified).

+ * otherwise return a 304 (not modified).

*/ IfNoneMatch?: string; /** *

Return the object only if it has not been modified since the specified time, otherwise - * return a 412 (precondition failed).

+ * return a 412 (precondition failed).

*/ IfUnmodifiedSince?: Date; @@ -8341,11 +8341,11 @@ export interface HeadObjectRequest { /** *

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.

- * - *

Amazon S3 doesn't support retrieving multiple ranges of data per GET - * request.

- * + * Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

+ * + *

Amazon S3 doesn't support retrieving multiple ranges of data per GET + * request.

+ * */ Range?: string; @@ -8356,37 +8356,37 @@ export interface HeadObjectRequest { /** *

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

+ * AES256).

*/ SSECustomerAlgorithm?: string; /** *

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

+ * 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.

*/ SSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ SSECustomerKeyMD5?: string; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

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

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.

+ * 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.

*/ PartNumber?: number; @@ -8409,23 +8409,23 @@ export namespace HeadObjectRequest { export interface ListBucketAnalyticsConfigurationsOutput { /** *

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.

+ * true indicates that the list is not complete and the NextContinuationToken will be provided + * for a subsequent request.

*/ IsTruncated?: boolean; /** *

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.

+ * response. This value is present if it was sent in the request.

*/ ContinuationToken?: string; /** *

- * 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.

+ * 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.

*/ NextContinuationToken?: string; @@ -8457,7 +8457,7 @@ export interface ListBucketAnalyticsConfigurationsRequest { /** *

The ContinuationToken that represents a placeholder from where this request should - * begin.

+ * begin.

*/ ContinuationToken?: string; @@ -8479,21 +8479,21 @@ export namespace ListBucketAnalyticsConfigurationsRequest { export interface ListBucketIntelligentTieringConfigurationsOutput { /** *

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.

+ * true indicates that the list is not complete and the NextContinuationToken will be provided + * for a subsequent request.

*/ IsTruncated?: boolean; /** *

The ContinuationToken that represents a placeholder from where this request should - * begin.

+ * begin.

*/ ContinuationToken?: string; /** *

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.

+ * NextContinuationToken from this response to continue the listing in a + * subsequent request. The continuation token is an opaque value that Amazon S3 understands.

*/ NextContinuationToken?: string; @@ -8520,7 +8520,7 @@ export interface ListBucketIntelligentTieringConfigurationsRequest { /** *

The ContinuationToken that represents a placeholder from where this request should - * begin.

+ * begin.

*/ ContinuationToken?: string; } @@ -8537,7 +8537,7 @@ export namespace ListBucketIntelligentTieringConfigurationsRequest { export interface ListBucketInventoryConfigurationsOutput { /** *

If sent in the request, the marker that is used as a starting point for this inventory - * configuration list response.

+ * configuration list response.

*/ ContinuationToken?: string; @@ -8548,15 +8548,15 @@ export interface ListBucketInventoryConfigurationsOutput { /** *

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.

+ * indicates that the list is not complete and the NextContinuationToken is provided for a + * subsequent request.

*/ IsTruncated?: boolean; /** *

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.

+ * NextContinuationToken from this response to continue the listing in a + * subsequent request. The continuation token is an opaque value that Amazon S3 understands.

*/ NextContinuationToken?: string; } @@ -8583,8 +8583,8 @@ export interface ListBucketInventoryConfigurationsRequest { /** *

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.

+ * Use the NextContinuationToken from a previously truncated list response to continue the + * listing. The continuation token is an opaque value that Amazon S3 understands.

*/ ContinuationToken?: string; @@ -8606,22 +8606,22 @@ export namespace ListBucketInventoryConfigurationsRequest { export interface ListBucketMetricsConfigurationsOutput { /** *

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.

+ * true indicates that the list is not complete and the NextContinuationToken will be provided + * for a subsequent request.

*/ IsTruncated?: boolean; /** *

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.

+ * response. This value is present if it was sent in the request.

*/ ContinuationToken?: string; /** *

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.

+ * the NextContinuationToken from a previously truncated list response to + * continue the listing. The continuation token is an opaque value that Amazon S3 + * understands.

*/ NextContinuationToken?: string; @@ -8653,9 +8653,9 @@ export interface ListBucketMetricsConfigurationsRequest { /** *

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.

+ * 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.

*/ ContinuationToken?: string; @@ -8676,7 +8676,7 @@ export namespace ListBucketMetricsConfigurationsRequest { /** *

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally - * unique, and the namespace is shared by all Amazon Web Services accounts.

+ * unique, and the namespace is shared by all Amazon Web Services accounts.

*/ export interface Bucket { /** @@ -8722,9 +8722,9 @@ export namespace ListBucketsOutput { /** *

Container for 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/.

+ * 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/.

*/ export interface CommonPrefix { /** @@ -8750,7 +8750,7 @@ export type EncodingType = "url"; export interface Initiator { /** *

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal - * is an IAM User, it provides a user ARN value.

+ * is an IAM User, it provides a user ARN value.

*/ ID?: string; @@ -8831,63 +8831,63 @@ export interface ListMultipartUploadsOutput { /** *

When a list is truncated, this element specifies the value that should be used for the - * key-marker request parameter in a subsequent request.

+ * key-marker request parameter in a subsequent request.

*/ NextKeyMarker?: string; /** *

When a prefix is provided in the request, this field contains the specified prefix. The - * result contains only keys starting with the specified prefix.

+ * result contains only keys starting with the specified prefix.

*/ Prefix?: string; /** *

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.

+ * your request, this element is absent from the response.

*/ Delimiter?: string; /** *

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.

+ * upload-id-marker request parameter in a subsequent request.

*/ NextUploadIdMarker?: string; /** *

Maximum number of multipart uploads that could have been included in the - * response.

+ * response.

*/ MaxUploads?: number; /** *

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.

+ * 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.

*/ IsTruncated?: boolean; /** *

Container for elements related to a particular multipart upload. A response can contain - * zero or more Upload elements.

+ * zero or more Upload elements.

*/ Uploads?: MultipartUpload[]; /** *

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.

+ * prefix containing the delimiter in a CommonPrefixes element. The distinct key + * prefixes are returned in the Prefix child element.

*/ CommonPrefixes?: CommonPrefix[]; /** *

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:

+ *

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.

+ *

+ * Delimiter, KeyMarker, Prefix, + * NextKeyMarker, Key.

*/ EncodingType?: EncodingType | string; } @@ -8904,63 +8904,63 @@ export namespace ListMultipartUploadsOutput { export interface ListMultipartUploadsRequest { /** *

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

- *

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

- *

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

+ *

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

+ *

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

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

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.

+ *

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.

*/ Delimiter?: string; /** *

Requests Amazon S3 to encode the object keys in the response and specifies the encoding - * method to use. An object key may contain any Unicode character; however, XML 1.0 parser - * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For - * characters that are not supported in XML 1.0, you can add this parameter to request that - * Amazon S3 encode the keys in the response.

+ * method to use. An object key may contain any Unicode character; however, XML 1.0 parser + * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For + * characters that are not supported in XML 1.0, you can add this parameter to request that + * Amazon S3 encode the keys in the response.

*/ EncodingType?: EncodingType | string; /** *

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.

+ * 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.

+ *

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.

*/ KeyMarker?: string; /** *

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.

+ * body. 1,000 is the maximum number of uploads that can be returned in a response.

*/ MaxUploads?: number; /** *

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.)

+ * 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.)

*/ Prefix?: string; /** *

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.

+ * 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.

*/ UploadIdMarker?: string; @@ -8995,7 +8995,7 @@ export type ObjectStorageClass = export interface _Object { /** *

The name that you assign to an object. You use the object key to retrieve the - * object.

+ * object.

*/ Key?: string; @@ -9006,25 +9006,25 @@ export interface _Object { /** *

The entity tag is a hash of the object. The ETag reflects changes only to the contents - * of an object, not its metadata. The ETag may or may not be an MD5 digest of the object - * data. Whether or not it is depends on how the object was created and how it is encrypted as - * described below:

- *
    - *
  • - *

    Objects created by the PUT Object, POST Object, or Copy operation, or through the - * Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are - * an MD5 digest of their object data.

    - *
    • - *
  • - *

    Objects created by the PUT Object, POST Object, or Copy operation, or through the - * Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are - * not an MD5 digest of their object data.

    - *
    • - *
  • - *

    If an object is created by either the Multipart Upload or Part Copy operation, the - * ETag is not an MD5 digest, regardless of the method of encryption.

    - *
    • - *
+ * of an object, not its metadata. The ETag may or may not be an MD5 digest of the object + * data. Whether or not it is depends on how the object was created and how it is encrypted as + * described below:

+ *
    + *
  • + *

    Objects created by the PUT Object, POST Object, or Copy operation, or through the + * Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are + * an MD5 digest of their object data.

    + *
    • + *
  • + *

    Objects created by the PUT Object, POST Object, or Copy operation, or through the + * Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are + * not an MD5 digest of their object data.

    + *
    • + *
  • + *

    If an object is created by either the Multipart Upload or Part Copy operation, the + * ETag is not an MD5 digest, regardless of the method of encryption.

    + *
    • + *
*/ ETag?: string; @@ -9056,23 +9056,23 @@ export namespace _Object { export interface ListObjectsOutput { /** *

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search - * criteria.

+ * criteria.

*/ IsTruncated?: boolean; /** *

Indicates where in the bucket listing begins. Marker is included in the response if it - * was sent with the request.

+ * was sent with the request.

*/ Marker?: string; /** *

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 NextMarker - * 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.

+ * 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 NextMarker + * 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.

*/ NextMarker?: string; @@ -9093,10 +9093,10 @@ export interface ListObjectsOutput { /** *

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.

+ * 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.

*/ Delimiter?: string; @@ -9107,19 +9107,19 @@ export interface ListObjectsOutput { /** *

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating - * the number of returns.

+ * the number of returns.

* - *

A response can contain CommonPrefixes only if you specify a delimiter.

+ *

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 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.

+ *

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.

+ *

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.

*/ CommonPrefixes?: CommonPrefix[]; @@ -9141,8 +9141,8 @@ export namespace ListObjectsOutput { export interface ListObjectsRequest { /** *

The name of the bucket containing the objects.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -9153,22 +9153,22 @@ export interface ListObjectsRequest { /** *

Requests Amazon S3 to encode the object keys in the response and specifies the encoding - * method to use. An object key may contain any Unicode character; however, XML 1.0 parser - * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For - * characters that are not supported in XML 1.0, you can add this parameter to request that - * Amazon S3 encode the keys in the response.

+ * method to use. An object key may contain any Unicode character; however, XML 1.0 parser + * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For + * characters that are not supported in XML 1.0, you can add this parameter to request that + * Amazon S3 encode the keys in the response.

*/ EncodingType?: EncodingType | string; /** *

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after - * this specified key. Marker can be any key in the bucket.

+ * this specified key. Marker can be any key in the bucket.

*/ Marker?: string; /** *

Sets the maximum number of keys returned in the response. By default the action returns up - * to 1,000 key names. The response might contain fewer keys but will never contain more. + * to 1,000 key names. The response might contain fewer keys but will never contain more. *

*/ MaxKeys?: number; @@ -9180,7 +9180,7 @@ export interface ListObjectsRequest { /** *

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.

+ * request. Bucket owners need not specify this parameter in their requests.

*/ RequestPayer?: RequestPayer | string; @@ -9219,8 +9219,8 @@ export namespace NoSuchBucket { export interface ListObjectsV2Output { /** *

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.

+ * to return. If the number of results exceeds that specified by MaxKeys, all of the results + * might not be returned.

*/ IsTruncated?: boolean; @@ -9231,8 +9231,8 @@ export interface ListObjectsV2Output { /** *

The bucket name.

- *

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

- *

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

+ *

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

+ *

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

*/ Name?: string; @@ -9243,57 +9243,57 @@ export interface ListObjectsV2Output { /** *

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.

+ * 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.

*/ Delimiter?: string; /** *

Sets the maximum number of keys returned in the response. By default the action returns up - * to 1,000 key names. The response might contain fewer keys but will never contain - * more.

+ * to 1,000 key names. The response might contain fewer keys but will never contain + * more.

*/ MaxKeys?: number; /** *

All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating - * the number of returns.

+ * the number of returns.

* - *

A response can contain CommonPrefixes only if you specify a - * delimiter.

+ *

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 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.

+ *

+ * 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.

+ *

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.

*/ CommonPrefixes?: CommonPrefix[]; /** *

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:

+ *

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.

+ *

+ * Delimiter, Prefix, Key, and StartAfter.

*/ EncodingType?: EncodingType | string; /** *

KeyCount is the number of keys returned with this request. KeyCount will always be less - * than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than - * equals 50 keys

+ * than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than + * equals 50 keys

*/ KeyCount?: number; @@ -9304,10 +9304,10 @@ export interface ListObjectsV2Output { /** *

- * 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

+ * 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

*/ NextContinuationToken?: string; @@ -9329,8 +9329,8 @@ export namespace ListObjectsV2Output { export interface ListObjectsV2Request { /** *

Bucket name to list.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -9346,8 +9346,8 @@ export interface ListObjectsV2Request { /** *

Sets the maximum number of keys returned in the response. By default the action returns up - * to 1,000 key names. The response might contain fewer keys but will never contain - * more.

+ * to 1,000 key names. The response might contain fewer keys but will never contain + * more.

*/ MaxKeys?: number; @@ -9358,26 +9358,26 @@ export interface ListObjectsV2Request { /** *

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.

+ * token. ContinuationToken is obfuscated and is not a real key.

*/ ContinuationToken?: string; /** *

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.

+ * with each key in the result then set the fetch owner field to true.

*/ FetchOwner?: boolean; /** *

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.

+ * specified key. StartAfter can be any key in the bucket.

*/ StartAfter?: string; /** *

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.

+ * request in V2 style. Bucket owners need not specify this parameter in their + * requests.

*/ RequestPayer?: RequestPayer | string; @@ -9417,7 +9417,7 @@ export interface DeleteMarkerEntry { /** *

Specifies whether the object is (true) or is not (false) the latest version of an - * object.

+ * object.

*/ IsLatest?: boolean; @@ -9469,7 +9469,7 @@ export interface ObjectVersion { /** *

Specifies whether the object is (true) or is not (false) the latest version of an - * object.

+ * object.

*/ IsLatest?: boolean; @@ -9496,9 +9496,9 @@ export namespace ObjectVersion { export interface ListObjectVersionsOutput { /** *

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.

+ * 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.

*/ IsTruncated?: boolean; @@ -9514,17 +9514,17 @@ export interface ListObjectVersionsOutput { /** *

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.

+ * 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.

*/ NextKeyMarker?: string; /** *

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.

+ * 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.

*/ NextVersionIdMarker?: string; @@ -9550,10 +9550,10 @@ export interface ListObjectVersionsOutput { /** *

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.

+ * 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.

*/ Delimiter?: string; @@ -9564,18 +9564,18 @@ export interface ListObjectVersionsOutput { /** *

All of the keys rolled up into a common prefix count as a single return when calculating - * the number of returns.

+ * the number of returns.

*/ CommonPrefixes?: CommonPrefix[]; /** *

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:

+ *

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.

+ *

+ * KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

*/ EncodingType?: EncodingType | string; } @@ -9597,19 +9597,19 @@ export interface ListObjectVersionsRequest { /** *

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.

+ * 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.

*/ Delimiter?: string; /** *

Requests Amazon S3 to encode the object keys in the response and specifies the encoding - * method to use. An object key may contain any Unicode character; however, XML 1.0 parser - * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For - * characters that are not supported in XML 1.0, you can add this parameter to request that - * Amazon S3 encode the keys in the response.

+ * method to use. An object key may contain any Unicode character; however, XML 1.0 parser + * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For + * characters that are not supported in XML 1.0, you can add this parameter to request that + * Amazon S3 encode the keys in the response.

*/ EncodingType?: EncodingType | string; @@ -9620,19 +9620,19 @@ export interface ListObjectVersionsRequest { /** *

Sets the maximum number of keys returned in the response. By default the action returns up - * to 1,000 key names. 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 true. To return the - * additional keys, see key-marker and version-id-marker.

+ * to 1,000 key names. 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 true. To return the + * additional keys, see key-marker and version-id-marker.

*/ MaxKeys?: number; /** *

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.

+ * 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.

*/ Prefix?: string; @@ -9662,7 +9662,7 @@ export namespace ListObjectVersionsRequest { export interface Part { /** *

Part number identifying the part. This is a positive integer between 1 and - * 10,000.

+ * 10,000.

*/ PartNumber?: number; @@ -9694,20 +9694,20 @@ export namespace Part { export interface ListPartsOutput { /** *

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.

+ * 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.

+ *

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.

*/ AbortDate?: Date; /** *

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.

+ * identifies applicable lifecycle configuration rule that defines the action to abort + * incomplete multipart uploads.

*/ AbortRuleId?: string; @@ -9728,15 +9728,15 @@ export interface ListPartsOutput { /** *

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.

+ * the value to use for the part-number-marker request parameter in a subsequent + * request.

*/ PartNumberMarker?: string; /** *

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.

+ * the value to use for the part-number-marker request parameter in a subsequent + * request.

*/ NextPartNumberMarker?: string; @@ -9747,41 +9747,41 @@ export interface ListPartsOutput { /** *

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.

+ * the list was truncated. A list can be truncated if the number of parts exceeds the limit + * returned in the MaxParts element.

*/ IsTruncated?: boolean; /** *

Container for elements related to a particular part. A response can contain zero or - * more Part elements.

+ * more Part elements.

*/ Parts?: Part[]; /** *

Container element that identifies who initiated the multipart upload. If the initiator - * is an Amazon Web Services 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.

+ * is an Amazon Web Services 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.

*/ Initiator?: Initiator; /** *

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.

+ * multipart upload is initiated by an IAM user, this element provides the parent account ID + * and display name.

*/ Owner?: Owner; /** *

Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded - * object.

+ * object.

*/ StorageClass?: StorageClass | string; /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -9798,8 +9798,8 @@ export namespace ListPartsOutput { export interface ListPartsRequest { /** *

The name of the bucket to which the parts are being uploaded.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -9815,7 +9815,7 @@ export interface ListPartsRequest { /** *

Specifies the part after which listing should begin. Only parts with higher part numbers - * will be listed.

+ * will be listed.

*/ PartNumberMarker?: string; @@ -9826,9 +9826,9 @@ export interface ListPartsRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -9886,17 +9886,17 @@ export interface PutBucketAclRequest { /** *

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. - *

- *

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

+ * integrity check to verify that the request body was not corrupted in transit. For more + * information, go to RFC + * 1864. + *

+ *

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

*/ ContentMD5?: string; /** *

Allows grantee the read, write, read ACP, and write ACP permissions on the - * bucket.

+ * bucket.

*/ GrantFullControl?: string; @@ -9912,7 +9912,7 @@ export interface PutBucketAclRequest { /** *

Allows grantee to create new objects in the bucket.

- *

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

+ *

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

*/ GrantWrite?: string; @@ -9977,13 +9977,13 @@ export namespace PutBucketAnalyticsConfigurationRequest { /** *

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 S3 User Guide.

+ * information, see Enabling + * Cross-Origin Resource Sharing in the Amazon S3 User Guide.

*/ export interface CORSConfiguration { /** *

A set of origins and methods (cross-origin access that you want to allow). You can add - * up to 100 rules to the configuration.

+ * up to 100 rules to the configuration.

*/ CORSRules: CORSRule[] | undefined; } @@ -10005,11 +10005,11 @@ export interface PutBucketCorsRequest { /** *

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. - *

- *

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

+ * integrity check to verify that the request body was not corrupted in transit. For more + * information, go to RFC + * 1864. + *

+ *

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

*/ ContentMD5?: string; @@ -10020,8 +10020,8 @@ export interface PutBucketCorsRequest { /** *

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 S3 User Guide.

+ * information, see Enabling Cross-Origin Resource + * Sharing in the Amazon S3 User Guide.

*/ CORSConfiguration: CORSConfiguration | undefined; } @@ -10038,15 +10038,15 @@ export namespace PutBucketCorsRequest { export interface PutBucketEncryptionRequest { /** *

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed - * keys (SSE-S3) or customer master keys stored in Amazon Web Services KMS (SSE-KMS). For information about - * the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption - * in the Amazon S3 User Guide.

+ * keys (SSE-S3) or customer master keys stored in Amazon Web Services KMS (SSE-KMS). For information about + * the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption + * in the Amazon S3 User Guide.

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

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -10137,8 +10137,8 @@ export namespace PutBucketInventoryConfigurationRequest { /** *

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more - * information, see Object Lifecycle Management - * in the Amazon S3 User Guide.

+ * information, see Object Lifecycle Management + * in the Amazon S3 User Guide.

*/ export interface BucketLifecycleConfiguration { /** @@ -10192,8 +10192,8 @@ export namespace PutBucketLifecycleConfigurationRequest { export interface BucketLoggingStatus { /** *

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys - * for a bucket. For more information, see PUT Bucket logging in the - * Amazon S3 API Reference.

+ * for a bucket. For more information, see PUT Bucket logging in the + * Amazon S3 API Reference.

*/ LoggingEnabled?: LoggingEnabled; } @@ -10215,7 +10215,7 @@ export interface PutBucketLoggingRequest { /** *

The MD5 hash of the PutBucketLogging request body.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -10286,7 +10286,7 @@ export interface PutBucketNotificationConfigurationRequest { /** *

A container for specifying the notification configuration of the bucket. If this element - * is empty, notifications are turned off for the bucket.

+ * is empty, notifications are turned off for the bucket.

*/ NotificationConfiguration: NotificationConfiguration | undefined; } @@ -10308,7 +10308,7 @@ export interface PutBucketOwnershipControlsRequest { /** *

The MD5 hash of the OwnershipControls request body.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -10319,7 +10319,7 @@ export interface PutBucketOwnershipControlsRequest { /** *

The OwnershipControls (BucketOwnerPreferred or ObjectWriter) that you want - * to apply to this Amazon S3 bucket.

+ * to apply to this Amazon S3 bucket.

*/ OwnershipControls: OwnershipControls | undefined; } @@ -10341,13 +10341,13 @@ export interface PutBucketPolicyRequest { /** *

The MD5 hash of the request body.

- *

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

+ *

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

*/ ContentMD5?: string; /** *

Set this parameter to true to confirm that you want to remove your permissions to change - * this bucket policy in the future.

+ * this bucket policy in the future.

*/ ConfirmRemoveSelfBucketAccess?: boolean; @@ -10379,9 +10379,9 @@ export interface PutBucketReplicationRequest { /** *

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.

- *

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

+ * integrity check to verify that the request body was not corrupted in transit. For more + * information, see RFC 1864.

+ *

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

*/ ContentMD5?: string; @@ -10397,7 +10397,7 @@ export interface PutBucketReplicationRequest { /** *

A container for replication rules. You can add up to 1,000 rules. The maximum size of a - * replication configuration is 2 MB.

+ * replication configuration is 2 MB.

*/ ReplicationConfiguration: ReplicationConfiguration | undefined; } @@ -10441,10 +10441,10 @@ export interface PutBucketRequestPaymentRequest { /** *

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.

- *

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

+ * message integrity check to verify that the request body was not corrupted in transit. For + * more information, see RFC + * 1864.

+ *

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

*/ ContentMD5?: string; @@ -10495,9 +10495,9 @@ export interface PutBucketTaggingRequest { /** *

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.

- *

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

+ * integrity check to verify that the request body was not corrupted in transit. For more + * information, see RFC 1864.

+ *

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

*/ ContentMD5?: string; @@ -10525,13 +10525,13 @@ export type MFADelete = "Disabled" | "Enabled"; /** *

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT - * Bucket versioning in the Amazon S3 API Reference.

+ * Bucket versioning in the Amazon S3 API Reference.

*/ export interface VersioningConfiguration { /** *

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.

+ * 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.

*/ MFADelete?: MFADelete | string; @@ -10558,16 +10558,16 @@ export interface PutBucketVersioningRequest { /** *

>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.

- *

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

+ * message integrity check to verify that the request body was not corrupted in transit. For + * more information, see RFC + * 1864.

+ *

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

*/ ContentMD5?: string; /** *

The concatenation of the authentication device's serial number, a space, and the value - * that is displayed on your authentication device.

+ * that is displayed on your authentication device.

*/ MFA?: string; @@ -10607,9 +10607,9 @@ export interface WebsiteConfiguration { /** *

The redirect behavior for every request to this bucket's website endpoint.

- * - *

If you specify this property, you can't specify any other property.

- * + * + *

If you specify this property, you can't specify any other property.

+ * */ RedirectAllRequestsTo?: RedirectAllRequestsTo; @@ -10636,9 +10636,9 @@ export interface PutBucketWebsiteRequest { /** *

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.

- *

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

+ * integrity check to verify that the request body was not corrupted in transit. For more + * information, see RFC 1864.

+ *

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

*/ ContentMD5?: string; @@ -10665,8 +10665,8 @@ export namespace PutBucketWebsiteRequest { export interface PutObjectOutput { /** *

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.

+ * 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.

*/ Expiration?: string; @@ -10677,8 +10677,8 @@ export interface PutObjectOutput { /** *

If you specified server-side encryption either with an Amazon Web Services 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.

+ * 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.

*/ ServerSideEncryption?: ServerSideEncryption | string; @@ -10689,29 +10689,29 @@ export interface PutObjectOutput { /** *

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

+ * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

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

+ * response will include this header to provide round-trip message integrity verification of + * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If x-amz-server-side-encryption is present and has the value of - * aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service - * (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the - * object.

+ * aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service + * (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the + * object.

*/ SSEKMSKeyId?: string; /** *

If present, specifies the Amazon Web Services 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.

+ * value of this header is a base64-encoded UTF-8 string holding JSON with the encryption + * context key-value pairs.

*/ SSEKMSEncryptionContext?: string; @@ -10722,7 +10722,7 @@ export interface PutObjectOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -10742,7 +10742,7 @@ export interface PutObjectRequest { /** *

The canned ACL to apply to the object. For more information, see Canned * ACL.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ ACL?: ObjectCannedACL | string; @@ -10753,14 +10753,14 @@ export interface PutObjectRequest { /** *

The bucket name to which the PUT action was initiated.

- *

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

- *

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

+ *

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

+ *

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

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

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.

+ * information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

*/ CacheControl?: string; @@ -10771,8 +10771,8 @@ export interface PutObjectRequest { /** *

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.

+ * 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.

*/ ContentEncoding?: string; @@ -10783,56 +10783,56 @@ export interface PutObjectRequest { /** *

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.

+ * determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

*/ ContentLength?: number; /** *

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.

+ * 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.

*/ ContentMD5?: string; /** *

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.

+ * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

*/ ContentType?: string; /** *

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.

+ * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

*/ Expires?: Date; /** *

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the * object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantFullControl?: string; /** *

Allows grantee to read the object data and its * metadata.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantRead?: string; /** *

Allows grantee to read the object ACL.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantReadACP?: string; /** *

Allows grantee to write the ACL for the applicable * object.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantWriteACP?: string; @@ -10848,100 +10848,100 @@ export interface PutObjectRequest { /** *

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

+ * AES256, aws:kms).

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The - * STANDARD storage class provides high durability and high availability. Depending on - * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses - * the OUTPOSTS Storage Class. For more information, see Storage Classes in the - * Amazon S3 User Guide.

+ * STANDARD storage class provides high durability and high availability. Depending on + * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses + * the OUTPOSTS Storage Class. For more information, see Storage Classes in the + * Amazon S3 User Guide.

*/ StorageClass?: StorageClass | string; /** *

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.

+ * 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:

+ *

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 - *

+ *

+ * x-amz-website-redirect-location: /anotherPage.html + *

* - *

In the following example, the request header sets the object redirect to another - * website:

+ *

In the following example, the request header sets the object redirect to another + * website:

* - *

- * x-amz-website-redirect-location: http://www.example.com/ - *

+ *

+ * 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.

+ *

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page + * Redirects.

*/ WebsiteRedirectLocation?: string; /** *

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

+ * AES256).

*/ SSECustomerAlgorithm?: string; /** *

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

+ * 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.

*/ SSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ SSECustomerKeyMD5?: string; /** *

If x-amz-server-side-encryption is present and has the value of - * aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service - * (Amazon Web Services KMS) symmetrical customer managed customer master key (CMK) that was 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 Amazon Web Services - * managed CMK in Amazon Web Services to protect the data. If the KMS key does not exist in the same account - * issuing the command, you must use the full ARN and not just the ID. + * aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service + * (Amazon Web Services KMS) symmetrical customer managed customer master key (CMK) that was 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 Amazon Web Services + * managed CMK in Amazon Web Services to protect the data. If the KMS key does not exist in the same account + * issuing the command, you must use the full ARN and not just the ID. *

*/ SSEKMSKeyId?: string; /** *

Specifies the Amazon Web Services 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.

+ * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value + * pairs.

*/ SSEKMSEncryptionContext?: string; /** *

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

- *

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

+ *

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

*/ BucketKeyEnabled?: boolean; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

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

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For - * example, "Key1=Value1")

+ * example, "Key1=Value1")

*/ Tagging?: string; @@ -10952,14 +10952,14 @@ export interface PutObjectRequest { /** *

The date and time when you want this object's Object Lock to expire. Must be formatted - * as a timestamp parameter.

+ * as a timestamp parameter.

*/ ObjectLockRetainUntilDate?: Date; /** *

Specifies whether a legal hold will be applied to this object. For more information - * about S3 Object Lock, see Object - * Lock.

+ * about S3 Object Lock, see Object + * Lock.

*/ ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string; @@ -10984,7 +10984,7 @@ export namespace PutObjectRequest { export interface PutObjectAclOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -11006,65 +11006,65 @@ export interface PutObjectAclRequest { /** *

The bucket name that contains the object to which you want to attach the ACL.

- *

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

+ *

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

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

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.> - *

- *

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

+ * integrity check to verify that the request body was not corrupted in transit. For more + * information, go to RFC + * 1864.> + *

+ *

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

*/ ContentMD5?: string; /** *

Allows grantee the read, write, read ACP, and write ACP permissions on the - * bucket.

- *

This action is not supported by Amazon S3 on Outposts.

+ * bucket.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantFullControl?: string; /** *

Allows grantee to list the objects in the * bucket.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantRead?: string; /** *

Allows grantee to read the bucket ACL.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantReadACP?: string; /** *

Allows grantee to create new objects in the bucket.

- *

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

+ *

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

*/ GrantWrite?: string; /** *

Allows grantee to write the ACL for the applicable * bucket.

- *

This action is not supported by Amazon S3 on Outposts.

+ *

This action is not supported by Amazon S3 on Outposts.

*/ GrantWriteACP?: string; /** *

Key for which the PUT action was initiated.

- *

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

- *

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

+ *

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

+ *

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

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

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -11096,7 +11096,7 @@ export namespace PutObjectAclRequest { export interface PutObjectLegalHoldOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -11113,7 +11113,7 @@ export namespace PutObjectLegalHoldOutput { export interface PutObjectLegalHoldRequest { /** *

The bucket name containing the object that you want to place a Legal Hold on.

- *

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

+ *

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

*/ Bucket: string | undefined; @@ -11124,9 +11124,9 @@ export interface PutObjectLegalHoldRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -11137,7 +11137,7 @@ export interface PutObjectLegalHoldRequest { /** *

The MD5 hash for the request body.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -11148,7 +11148,7 @@ export interface PutObjectLegalHoldRequest { /** *

Container element for the Legal Hold configuration you want to apply to the specified - * object.

+ * object.

*/ LegalHold?: ObjectLockLegalHold; } @@ -11165,7 +11165,7 @@ export namespace PutObjectLegalHoldRequest { export interface PutObjectLockConfigurationOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -11187,9 +11187,9 @@ export interface PutObjectLockConfigurationRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -11200,7 +11200,7 @@ export interface PutObjectLockConfigurationRequest { /** *

The MD5 hash for the request body.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -11227,7 +11227,7 @@ export namespace PutObjectLockConfigurationRequest { export interface PutObjectRetentionOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -11244,28 +11244,28 @@ export namespace PutObjectRetentionOutput { export interface PutObjectRetentionRequest { /** *

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

- *

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

+ * configuration to.

+ *

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

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

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

+ * to.

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

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

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

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

+ * to.

*/ VersionId?: string; @@ -11276,7 +11276,7 @@ export interface PutObjectRetentionRequest { /** *

The MD5 hash for the request body.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -11319,8 +11319,8 @@ export namespace PutObjectTaggingOutput { export interface PutObjectTaggingRequest { /** *

The bucket name containing the object.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -11336,7 +11336,7 @@ export interface PutObjectTaggingRequest { /** *

The MD5 hash for the request body.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -11347,9 +11347,9 @@ export interface PutObjectTaggingRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -11371,13 +11371,13 @@ export namespace PutObjectTaggingRequest { export interface PutPublicAccessBlockRequest { /** *

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

+ * to set.

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

The MD5 hash of the PutPublicAccessBlock request body.

- *

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

+ *

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

*/ ContentMD5?: string; @@ -11388,8 +11388,8 @@ export interface PutPublicAccessBlockRequest { /** *

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

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

*/ PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined; } @@ -11423,13 +11423,13 @@ export namespace ObjectAlreadyInActiveTierError { export interface RestoreObjectOutput { /** *

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

+ * request.

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

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

+ * restored to.

*/ RestoreOutputPath?: string; } diff --git a/clients/client-s3/src/models/models_1.ts b/clients/client-s3/src/models/models_1.ts index f1420a2..c673b2f 100644 --- a/clients/client-s3/src/models/models_1.ts +++ b/clients/client-s3/src/models/models_1.ts @@ -21,21 +21,21 @@ import { Readable } from "stream"; export interface Encryption { /** *

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

+ * AES256, aws:kms).

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

If the encryption type is aws:kms, this optional value specifies the ID of - * the symmetric customer managed Amazon Web Services 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 Amazon Web Services Key Management Service Developer Guide.

+ * the symmetric customer managed Amazon Web Services 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 Amazon Web Services Key Management Service Developer Guide.

*/ KMSKeyId?: string; /** *

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

+ * specify the encryption context for the restore results.

*/ KMSContext?: string; } @@ -161,72 +161,72 @@ export enum FileHeaderInfo { /** *

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

+ * formatted.

*/ export interface CSVInput { /** *

Describes the first line of input. Valid values are:

- *
    - *
  • - *

    - * NONE: First line is not a header.

    - *
    • - *
  • - *

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

    - *
    • - *
  • - *

    - * Use: First line is a header, and you can use the header value to - * identify a column in an expression (SELECT "name" FROM OBJECT).

    - *
    • - *
+ *
    + *
  • + *

    + * NONE: First line is not a header.

    + *
    • + *
  • + *

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

    + *
    • + *
  • + *

    + * Use: First line is a header, and you can use the header value to + * identify a column in an expression (SELECT "name" FROM OBJECT).

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

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

+ * present at the start of that row. You can specify any character to indicate a comment + * line.

*/ Comments?: string; /** *

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

+ * escaped value. For example, the value """ a , b """ is parsed as " a , b ".

*/ QuoteEscapeCharacter?: string; /** *

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

+ * default value, you can specify an arbitrary delimiter.

*/ RecordDelimiter?: string; /** *

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

+ * arbitrary delimiter.

*/ FieldDelimiter?: string; /** *

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

- *

Type: String

- *

Default: " - *

- *

Ancestors: CSV - *

+ * example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, + * as follows: " a , b ".

+ *

Type: String

+ *

Default: " + *

+ *

Ancestors: CSV + *

*/ QuoteCharacter?: string; /** *

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

+ * should be allowed. Default value is FALSE. Setting this value to TRUE may lower + * performance.

*/ AllowQuotedRecordDelimiter?: boolean; } @@ -289,7 +289,7 @@ export interface InputSerialization { /** *

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

+ * NONE.

*/ CompressionType?: CompressionType | string; @@ -320,46 +320,46 @@ export enum QuoteFields { /** *

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

+ * formatted.

*/ export interface CSVOutput { /** *

Indicates whether to use quotation marks around output fields.

- *
    - *
  • - *

    - * ALWAYS: Always use quotation marks for output fields.

    - *
    • - *
  • - *

    - * ASNEEDED: Use quotation marks for output fields when needed.

    - *
    • - *
+ *
    + *
  • + *

    + * ALWAYS: Always use quotation marks for output fields.

    + *
    • + *
  • + *

    + * ASNEEDED: Use quotation marks for output fields when needed.

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

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

+ * value.

*/ QuoteEscapeCharacter?: string; /** *

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

+ * default value, you can specify an arbitrary delimiter.

*/ RecordDelimiter?: string; /** *

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

+ * delimiter.

*/ FieldDelimiter?: string; /** *

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

+ * example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, + * as follows: " a , b ".

*/ QuoteCharacter?: string; } @@ -379,7 +379,7 @@ export namespace CSVOutput { export interface JSONOutput { /** *

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

+ * Amazon S3 uses a newline character ('\n').

*/ RecordDelimiter?: string; } @@ -461,15 +461,15 @@ export enum RestoreRequestType { export interface RestoreRequest { /** *

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

- *

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

+ * OutputLocation.

+ *

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

*/ Days?: number; /** *

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

+ * specify OutputLocation.

*/ GlacierJobParameters?: GlacierJobParameters; @@ -512,8 +512,8 @@ export namespace RestoreRequest { export interface RestoreObjectRequest { /** *

The bucket name containing the object to restore.

- *

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

- *

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

+ *

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

+ *

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

*/ Bucket: string | undefined; @@ -529,9 +529,9 @@ export interface RestoreObjectRequest { /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -572,8 +572,8 @@ export namespace ContinuationEvent { /** *

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

+ * should not assume that the request is complete until the client receives an + * EndEvent.

*/ export interface EndEvent {} @@ -832,12 +832,12 @@ export namespace SelectObjectContentOutput { /** *

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

+ * sent.

*/ export interface RequestProgress { /** *

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

+ * FALSE. Default value: FALSE.

*/ Enabled?: boolean; } @@ -853,27 +853,27 @@ export namespace RequestProgress { /** *

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.

+ * when its first byte is contained by the range. This parameter is optional, but when + * specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the + * start and end of the range.

*/ export interface ScanRange { /** *

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

+ * non-negative integers. The default value is 0. If only start is supplied, it means scan + * from that point to the end of the file.For example; + * 50 means scan + * from byte 50 until the end of the file.

*/ Start?: number; /** *

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

+ * non-negative integers. The default value is one less than the size of the object being + * queried. If only the End parameter is supplied, it is interpreted to mean scan the last N + * bytes of the file. For example, + * 50 means scan the + * last 50 bytes.

*/ End?: number; } @@ -889,11 +889,11 @@ export namespace ScanRange { /** *

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

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

*/ export interface SelectObjectContentRequest { /** @@ -913,13 +913,13 @@ export interface SelectObjectContentRequest { /** *

The SSE Customer Key. For more information, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys.

+ * (Using Customer-Provided Encryption Keys.

*/ SSECustomerKey?: string; /** *

The SSE Customer Key MD5. For more information, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys.

+ * (Using Customer-Provided Encryption Keys.

*/ SSECustomerKeyMD5?: string; @@ -950,29 +950,29 @@ export interface SelectObjectContentRequest { /** *

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:

- *
    - *
  • - *

    - * 50100 - * - process only the records starting between the bytes 50 and 100 (inclusive, counting - * from zero)

    - *
    • - *
  • - *

    - * 50 - - * process only the records starting after the byte 50

    - *
    • - *
  • - *

    - * 50 - - * process only the records within the last 50 bytes of the file.

    - *
    • - *
+ * 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:

+ *
    + *
  • + *

    + * 50100 + * - process only the records starting between the bytes 50 and 100 (inclusive, counting + * from zero)

    + *
    • + *
  • + *

    + * 50 - + * process only the records starting after the byte 50

    + *
    • + *
  • + *

    + * 50 - + * process only the records within the last 50 bytes of the file.

    + *
    • + *
*/ ScanRange?: ScanRange; @@ -995,7 +995,7 @@ export namespace SelectObjectContentRequest { export interface UploadPartOutput { /** *

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

+ * AES256, aws:kms).

*/ ServerSideEncryption?: ServerSideEncryption | string; @@ -1006,20 +1006,20 @@ export interface UploadPartOutput { /** *

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

+ * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

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

+ * response will include this header to provide round-trip message integrity verification of + * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed customer master key (CMK) was used for the object.

+ * customer managed customer master key (CMK) was used for the object.

*/ SSEKMSKeyId?: string; @@ -1030,7 +1030,7 @@ export interface UploadPartOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -1053,21 +1053,21 @@ export interface UploadPartRequest { /** *

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

- *

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

- *

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

+ *

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

+ *

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

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

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

+ * determined automatically.

*/ ContentLength?: number; /** *

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

+ * when using the command from the CLI. This parameter is required if object lock parameters + * are specified.

*/ ContentMD5?: string; @@ -1078,7 +1078,7 @@ export interface UploadPartRequest { /** *

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

+ * 10,000.

*/ PartNumber: number | undefined; @@ -1089,31 +1089,31 @@ export interface UploadPartRequest { /** *

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

+ * AES256).

*/ SSECustomerAlgorithm?: string; /** *

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

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

*/ SSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ SSECustomerKeyMD5?: string; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -1160,7 +1160,7 @@ export namespace CopyPartResult { export interface UploadPartCopyOutput { /** *

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

+ * source bucket.

*/ CopySourceVersionId?: string; @@ -1171,26 +1171,26 @@ export interface UploadPartCopyOutput { /** *

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

+ * AES256, aws:kms).

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

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

+ * response will include this header confirming the encryption algorithm used.

*/ SSECustomerAlgorithm?: string; /** *

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

+ * response will include this header to provide round-trip message integrity verification of + * the customer-provided encryption key.

*/ SSECustomerKeyMD5?: string; /** *

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * customer managed customer master key (CMK) that was used for the object.

+ * customer managed customer master key (CMK) that was used for the object.

*/ SSEKMSKeyId?: string; @@ -1201,7 +1201,7 @@ export interface UploadPartCopyOutput { /** *

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

+ * request.

*/ RequestCharged?: RequestCharged | string; } @@ -1219,36 +1219,36 @@ export namespace UploadPartCopyOutput { export interface UploadPartCopyRequest { /** *

The bucket name.

- *

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

- *

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

+ *

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

+ *

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

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

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

- *
    - *
  • - *

    For objects not accessed through an access point, specify the name of the source - * bucket and key of the source object, separated by a slash (/). For example, to copy - * the object reports/january.pdf from the bucket - * awsexamplebucket, use - * awsexamplebucket/reports/january.pdf. The value must be URL - * encoded.

    - *
    • - *
  • - *

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    - * - *

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    - *     - *

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    - *
    • - *
- *

To copy a specific version of an object, append ?versionId= - * to the value (for example, - * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). - * If you don't specify a version ID, Amazon S3 copies the latest version of the source - * object.

+ * formats, depending on whether you want to access the source object through an access point:

+ *
    + *
  • + *

    For objects not accessed through an access point, specify the name of the source + * bucket and key of the source object, separated by a slash (/). For example, to copy + * the object reports/january.pdf from the bucket + * awsexamplebucket, use + * awsexamplebucket/reports/january.pdf. The value must be URL + * encoded.

    + *
    • + *
  • + *

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    + * + *

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    + *     + *

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    + *
    • + *
+ *

To copy a specific version of an object, append ?versionId= + * to the value (for example, + * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). + * If you don't specify a version ID, Amazon S3 copies the latest version of the source + * object.

*/ CopySource: string | undefined; @@ -1274,9 +1274,9 @@ export interface UploadPartCopyRequest { /** *

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.

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

*/ CopySourceRange?: string; @@ -1287,7 +1287,7 @@ export interface UploadPartCopyRequest { /** *

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

+ * 10,000.

*/ PartNumber: number | undefined; @@ -1298,51 +1298,51 @@ export interface UploadPartCopyRequest { /** *

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

+ * AES256).

*/ SSECustomerAlgorithm?: string; /** *

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

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

*/ SSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ SSECustomerKeyMD5?: string; /** *

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

+ * AES256).

*/ CopySourceSSECustomerAlgorithm?: string; /** *

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

+ * object. The encryption key provided in this header must be one that was used when the + * source object was created.

*/ CopySourceSSECustomerKey?: string; /** *

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

+ * this header for a message integrity check to ensure that the encryption key was transmitted + * without error.

*/ CopySourceSSECustomerKeyMD5?: string; /** *

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

+ * owners need not specify this parameter in their requests. For information about downloading + * objects from requester pays buckets, see Downloading Objects in + * Requestor Pays Buckets in the Amazon S3 User Guide.

*/ RequestPayer?: RequestPayer | string; @@ -1376,7 +1376,7 @@ export interface WriteGetObjectResponseRequest { /** *

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

+ * user GetObject request.

*/ RequestToken: string | undefined; @@ -1387,98 +1387,98 @@ export interface WriteGetObjectResponseRequest { /** *

The integer status code for an HTTP response of a corresponding GetObject - * request.

- *

- * Status Codes - *

- *
    - *
  • - *

    - * 200 - OK - *

    - *
    • - *
  • - *

    - * 206 - Partial Content - *

    - *
    • - *
  • - *

    - * 304 - Not Modified - *

    - *
    • - *
  • - *

    - * 400 - Bad Request - *

    - *
    • - *
  • - *

    - * 401 - Unauthorized - *

    - *
    • - *
  • - *

    - * 403 - Forbidden - *

    - *
    • - *
  • - *

    - * 404 - Not Found - *

    - *
    • - *
  • - *

    - * 405 - Method Not Allowed - *

    - *
    • - *
  • - *

    - * 409 - Conflict - *

    - *
    • - *
  • - *

    - * 411 - Length Required - *

    - *
    • - *
  • - *

    - * 412 - Precondition Failed - *

    - *
    • - *
  • - *

    - * 416 - Range Not Satisfiable - *

    - *
    • - *
  • - *

    - * 500 - Internal Server Error - *

    - *
    • - *
  • - *

    - * 503 - Service Unavailable - *

    - *
    • - *
+ * request.

+ *

+ * Status Codes + *

+ *
    + *
  • + *

    + * 200 - OK + *

    + *
    • + *
  • + *

    + * 206 - Partial Content + *

    + *
    • + *
  • + *

    + * 304 - Not Modified + *

    + *
    • + *
  • + *

    + * 400 - Bad Request + *

    + *
    • + *
  • + *

    + * 401 - Unauthorized + *

    + *
    • + *
  • + *

    + * 403 - Forbidden + *

    + *
    • + *
  • + *

    + * 404 - Not Found + *

    + *
    • + *
  • + *

    + * 405 - Method Not Allowed + *

    + *
    • + *
  • + *

    + * 409 - Conflict + *

    + *
    • + *
  • + *

    + * 411 - Length Required + *

    + *
    • + *
  • + *

    + * 412 - Precondition Failed + *

    + *
    • + *
  • + *

    + * 416 - Range Not Satisfiable + *

    + *
    • + *
  • + *

    + * 500 - Internal Server Error + *

    + *
    • + *
  • + *

    + * 503 - Service Unavailable + *

    + *
    • + *
*/ StatusCode?: number; /** *

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

+ * of the error XML response for a corresponding GetObject call. Cannot be used + * with a successful StatusCode header or when the transformed object is provided + * in the body. All error codes from S3 are sentence-cased. Regex value is "^[A-Z][a-zA-Z]+$".

*/ ErrorCode?: string; /** *

Contains a generic description of the error condition. Returned in the - * tag of the error XML response for a corresponding GetObject call. Cannot be - * used with a successful StatusCode header or when the transformed object is - * provided in body.

+ * tag of the error XML response for a corresponding GetObject call. Cannot be + * used with a successful StatusCode header or when the transformed object is + * provided in body.

*/ ErrorMessage?: string; @@ -1499,8 +1499,8 @@ export interface WriteGetObjectResponseRequest { /** *

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.

+ * mechanisms must be applied to obtain the media-type referenced by the Content-Type header + * field.

*/ ContentEncoding?: string; @@ -1526,13 +1526,13 @@ export interface WriteGetObjectResponseRequest { /** *

Specifies whether an object stored in Amazon S3 is (true) or is not - * (false) a delete marker.

+ * (false) a delete marker.

*/ DeleteMarker?: boolean; /** *

An opaque identifier assigned by a web server to a specific version of a resource found - * at a URL.

+ * at a URL.

*/ ETag?: string; @@ -1553,9 +1553,9 @@ export interface WriteGetObjectResponseRequest { /** *

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.

+ * This can happen if you create metadata using an API like SOAP that supports more flexible + * metadata than the REST API. For example, using SOAP, you can create metadata whose values + * are not legal HTTP headers.

*/ MissingMeta?: number; @@ -1566,7 +1566,7 @@ export interface WriteGetObjectResponseRequest { /** *

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more - * information about S3 Object Lock, see Object Lock.

+ * information about S3 Object Lock, see Object Lock.

*/ ObjectLockMode?: ObjectLockMode | string; @@ -1587,19 +1587,19 @@ export interface WriteGetObjectResponseRequest { /** *

Indicates if request involves bucket that is either a source or destination in a Replication rule. For more - * information about S3 Replication, see Replication.

+ * information about S3 Replication, see Replication.

*/ ReplicationStatus?: ReplicationStatus | string; /** *

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

+ * request.

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

Provides information about object restoration operation and expiration time of the - * restored object copy.

+ * restored object copy.

*/ Restore?: string; @@ -1620,9 +1620,9 @@ export interface WriteGetObjectResponseRequest { /** *

128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data - * stored in S3. For more information, see Protecting data - * using server-side encryption with customer-provided encryption keys - * (SSE-C).

+ * stored in S3. For more information, see Protecting data + * using server-side encryption with customer-provided encryption keys + * (SSE-C).

*/ SSECustomerKeyMD5?: string; @@ -1643,7 +1643,7 @@ export interface WriteGetObjectResponseRequest { /** *

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side - * encryption with Amazon Web Services KMS (SSE-KMS).

+ * encryption with Amazon Web Services KMS (SSE-KMS).

*/ BucketKeyEnabled?: boolean; }