@aws-sdk/client-s3 3.458.0 → 3.461.0

package/dist-types/commands/GetBucketVersioningCommand.d.ts

@@ -23,7 +23,10 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
 }
 /**
  * @public
- * <p>Returns the versioning state of a bucket.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns the versioning state of a bucket.</p>
  *          <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p>
  *          <p>This implementation also returns the MFA Delete status of the versioning state. If the
  *          MFA Delete status is <code>enabled</code>, the bucket owner must use an authentication

package/dist-types/commands/GetBucketWebsiteCommand.d.ts

@@ -23,7 +23,10 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
 }
 /**
  * @public
- * <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p>
  *          <p>This GET action requires the <code>S3:GetBucketWebsite</code> permission. By default,

package/dist-types/commands/GetObjectAclCommand.d.ts

@@ -23,12 +23,15 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
 }
 /**
  * @public
- * <p>Returns the access control list (ACL) of an object. To use this operation, you must have
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns the access control list (ACL) of an object. To use this operation, you must have
  *             <code>s3:GetObjectAcl</code> permissions or <code>READ_ACP</code> access to the object.
  *          For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping">Mapping of ACL permissions and access policy permissions</a> in the <i>Amazon S3
  *             User Guide</i>
  *          </p>
- *          <p>This action is not supported by Amazon S3 on Outposts.</p>
+ *          <p>This functionality is not supported for Amazon S3 on Outposts.</p>
  *          <p>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.</p>
  *          <note>

package/dist-types/commands/GetObjectAttributesCommand.d.ts

@@ -24,111 +24,148 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
 /**
  * @public
  * <p>Retrieves all the metadata from an object without returning the object itself. This
- *          action is useful if you're interested only in an object's metadata. To use
- *             <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
+ *          operation is useful if you're interested only in an object's metadata. </p>
  *          <p>
  *             <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code>
  *          and <code>ListParts</code>. All of the data returned with each of those individual calls
  *          can be returned with a single call to <code>GetObjectAttributes</code>.</p>
- *          <p>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:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <code>x-amz-server-side-encryption-customer-algorithm</code>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>x-amz-server-side-encryption-customer-key</code>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>x-amz-server-side-encryption-customer-key-MD5</code>
- *                </p>
- *             </li>
- *          </ul>
- *          <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
- *             (Using Customer-Provided Encryption Keys)</a> in the
- *             <i>Amazon S3 User Guide</i>.</p>
  *          <note>
- *             <ul>
- *                <li>
- *                   <p>Encryption request headers, such as <code>x-amz-server-side-encryption</code>,
- *                   should not be sent for GET requests if your object uses server-side encryption
- *                   with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or
- *                   server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use
- *                   these types of keys, you'll get an HTTP <code>400 Bad Request</code> error.</p>
- *                </li>
- *                <li>
- *                   <p> The last modified property in this case is the creation date of the
- *                   object.</p>
- *                </li>
- *             </ul>
+ *             <p>
+ *                <b>Directory buckets</b> -  For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
+ *                </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
+ *     <i>Amazon S3 User Guide</i>.</p>
  *          </note>
- *          <p>Consider the following when using request headers:</p>
- *          <ul>
- *             <li>
- *                <p> If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers
- *                are present in the request as follows, then Amazon S3 returns the HTTP status code
- *                   <code>200 OK</code> and the data requested:</p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <code>If-Match</code> condition evaluates to <code>true</code>.</p>
+ *                         <b>General purpose bucket permissions</b> - To use
+ *                         <code>GetObjectAttributes</code>, you must have READ access to the object. The permissions that you need to use this operation with depend on whether the
+ *                         bucket is versioned. If the bucket is versioned, you need both the
+ *                         <code>s3:GetObjectVersion</code> and <code>s3:GetObjectVersionAttributes</code>
+ *                         permissions for this operation. If the bucket is not versioned, you need the
+ *                         <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> permissions.
+ *                         For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in
+ *                            a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object
+ *                         that you request does not exist, the error Amazon S3 returns depends on whether you
+ *                         also have the <code>s3:ListBucket</code> permission.</p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
+ *                               returns an HTTP status code <code>404 Not Found</code> ("no such key")
+ *                               error.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns
+ *                               an HTTP status code <code>403 Forbidden</code> ("access denied")
+ *                               error.</p>
+ *                         </li>
+ *                      </ul>
  *                   </li>
  *                   <li>
  *                      <p>
- *                         <code>If-Unmodified-Since</code> condition evaluates to
- *                      <code>false</code>.</p>
+ *                         <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
+ *                            <code>CreateSession</code>
+ *                         </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use.
+ * Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
+ *                            <code>CreateSession</code>
+ *                         </a>.</p>
  *                   </li>
  *                </ul>
- *             </li>
- *             <li>
- *                <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
- *                headers are present in the request as follows, then Amazon S3 returns the HTTP status code
- *                   <code>304 Not Modified</code>:</p>
+ *             </dd>
+ *             <dt>Encryption</dt>
+ *             <dd>
+ *                <note>
+ *                   <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
+ *                   should not be sent for <code>HEAD</code> requests if your object uses server-side
+ *                   encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side
+ *                   encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3
+ *                   managed encryption keys (SSE-S3). The <code>x-amz-server-side-encryption</code> header is used when you <code>PUT</code> an object to S3 and want to specify the encryption method.
+ *                   If you include this header in a <code>GET</code> request for an object that uses these types of keys,
+ *                   you’ll get an HTTP <code>400 Bad Request</code> error. It's because the encryption method can't be changed when you retrieve the object.</p>
+ *                </note>
+ *                <p>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 to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: </p>
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <code>If-None-Match</code> condition evaluates to <code>false</code>.</p>
+ *                         <code>x-amz-server-side-encryption-customer-algorithm</code>
+ *                      </p>
  *                   </li>
  *                   <li>
  *                      <p>
- *                         <code>If-Modified-Since</code> condition evaluates to
- *                      <code>true</code>.</p>
+ *                         <code>x-amz-server-side-encryption-customer-key</code>
+ *                      </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <code>x-amz-server-side-encryption-customer-key-MD5</code>
+ *                      </p>
  *                   </li>
  *                </ul>
- *             </li>
- *          </ul>
- *          <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
- *          <dl>
- *             <dt>Permissions</dt>
+ *                <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
+ *                   (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3
+ *                      User Guide</i>.</p>
+ *                <note>
+ *                   <p>
+ *                      <b>Directory bucket permissions</b> - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
+ *                </note>
+ *             </dd>
+ *             <dt>Versioning</dt>
  *             <dd>
- *                <p>The permissions that you need to use this operation depend on whether the
- *                   bucket is versioned. If the bucket is versioned, you need both the
- *                      <code>s3:GetObjectVersion</code> and <code>s3:GetObjectVersionAttributes</code>
- *                   permissions for this operation. If the bucket is not versioned, you need the
- *                      <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> permissions.
- *                   For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in
- *                      a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object
- *                   that you request does not exist, the error Amazon S3 returns depends on whether you
- *                   also have the <code>s3:ListBucket</code> permission.</p>
+ *                <p>
+ *                   <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code>
+ *                         to the <code>versionId</code> query parameter in the request.</p>
+ *             </dd>
+ *             <dt>Conditional request headers</dt>
+ *             <dd>
+ *                <p>Consider the following when using request headers:</p>
  *                <ul>
  *                   <li>
- *                      <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
- *                         returns an HTTP status code <code>404 Not Found</code> ("no such key")
- *                         error.</p>
+ *                      <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers
+ *                         are present in the request as follows, then Amazon S3 returns the HTTP status code
+ *                         <code>200 OK</code> and the data requested:</p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>
+ *                               <code>If-Match</code> condition evaluates to <code>true</code>.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>
+ *                               <code>If-Unmodified-Since</code> condition evaluates to
+ *                               <code>false</code>.</p>
+ *                         </li>
+ *                      </ul>
+ *                      <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
  *                   </li>
  *                   <li>
- *                      <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns
- *                         an HTTP status code <code>403 Forbidden</code> ("access denied")
- *                         error.</p>
+ *                      <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
+ *                         headers are present in the request as follows, then Amazon S3 returns the HTTP status code
+ *                         <code>304 Not Modified</code>:</p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>
+ *                               <code>If-None-Match</code> condition evaluates to <code>false</code>.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>
+ *                               <code>If-Modified-Since</code> condition evaluates to
+ *                               <code>true</code>.</p>
+ *                         </li>
+ *                      </ul>
+ *                      <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
  *                   </li>
  *                </ul>
  *             </dd>
+ *             <dt>HTTP Host header syntax</dt>
+ *             <dd>
+ *                <p>
+ *                   <b>Directory buckets </b> - The HTTP Host header syntax is <code>
+ *                      <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
+ *             </dd>
  *          </dl>
  *          <p>The following actions are related to <code>GetObjectAttributes</code>:</p>
  *          <ul>
@@ -225,7 +262,7 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
  * //       },
  * //     ],
  * //   },
- * //   StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
+ * //   StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE",
  * //   ObjectSize: Number("long"),
  * // };
  *