@aws-sdk/client-s3 3.844.0 → 3.846.0

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

@@ -31,18 +31,17 @@ declare const GetObjectCommand_base: {
  * <p>Retrieves an object from Amazon S3.</p>
  *          <p>In the <code>GetObject</code> request, specify the full key name for the object.</p>
  *          <p>
- *             <b>General purpose buckets</b> - Both the virtual-hosted-style
- *          requests and the path-style requests are supported. For a virtual hosted-style request
- *          example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the
- *          object key name as <code>/photos/2006/February/sample.jpg</code>. For a path-style request
- *          example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket
- *          named <code>examplebucket</code>, specify the object key name as
- *             <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about
- *          request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host
- *             Header Bucket Specification</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *             <b>General purpose buckets</b> - Both the virtual-hosted-style requests
+ *       and the path-style requests are supported. For a virtual hosted-style request example, if you have the
+ *       object <code>photos/2006/February/sample.jpg</code>, specify the object key name as
+ *         <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the
+ *       object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>,
+ *       specify the object key name as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more
+ *       information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host Header Bucket
+ *         Specification</a> in the <i>Amazon S3 User Guide</i>.</p>
  *          <p>
  *             <b>Directory buckets</b> -
- *          Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>amzn-s3-demo-bucket--usw2-az1--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
+ *       Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>amzn-s3-demo-bucket--usw2-az1--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
  *             </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
  *     <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
  *     <i>Amazon S3 User Guide</i>.</p>
@@ -52,35 +51,28 @@ declare const GetObjectCommand_base: {
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <b>General purpose bucket permissions</b> - You
- *                         must have the required permissions in a policy. To use
- *                            <code>GetObject</code>, you must have the <code>READ</code> access to the
- *                         object (or version). If you grant <code>READ</code> access to the anonymous
- *                         user, the <code>GetObject</code> operation returns the object without using
- *                         an authorization header. 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>.</p>
- *                      <p>If you include a <code>versionId</code> in your request header, you must
- *                         have the <code>s3:GetObjectVersion</code> permission to access a specific
- *                         version of an object. The <code>s3:GetObject</code> permission is not
- *                         required in this scenario.</p>
- *                      <p>If you request the current version of an object without a specific
- *                            <code>versionId</code> in the request header, only the
- *                            <code>s3:GetObject</code> permission is required. The
- *                            <code>s3:GetObjectVersion</code> permission is not required in this
- *                         scenario. </p>
- *                      <p>If the object that you request doesn’t exist, the error that Amazon S3 returns
- *                         depends on whether you also have the <code>s3:ListBucket</code>
- *                         permission.</p>
+ *                         <b>General purpose bucket permissions</b> - You must have the
+ *                 required permissions in a policy. To use <code>GetObject</code>, you must have the
+ *                   <code>READ</code> access to the object (or version). If you grant <code>READ</code> access
+ *                 to the anonymous user, the <code>GetObject</code> operation returns the object without using
+ *                 an authorization header. 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>.</p>
+ *                      <p>If you include a <code>versionId</code> in your request header, you must have the
+ *                   <code>s3:GetObjectVersion</code> permission to access a specific version of an object. The
+ *                   <code>s3:GetObject</code> permission is not required in this scenario.</p>
+ *                      <p>If you request the current version of an object without a specific <code>versionId</code>
+ *                 in the request header, only the <code>s3:GetObject</code> permission is required. The
+ *                   <code>s3:GetObjectVersion</code> permission is not required in this scenario. </p>
+ *                      <p>If the object that you request doesn’t exist, the error that 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>
- *                               error.</p>
+ *                            <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> 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 Access Denied</code>
- *                               error.</p>
+ *                            <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
+ *                     status code <code>403 Access Denied</code> error.</p>
  *                         </li>
  *                      </ul>
  *                   </li>
@@ -92,60 +84,54 @@ declare const GetObjectCommand_base: {
  * 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>
- *                      <p>If
- *                         the
- *                         object is encrypted using SSE-KMS, you must also have the
- *                            <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions
- *                         in IAM identity-based policies and KMS key policies for the KMS
- *                         key.</p>
+ *                      <p>If the object is
+ *                 encrypted using SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and
+ *                   <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies
+ *                 for the KMS key.</p>
  *                   </li>
  *                </ul>
  *             </dd>
  *             <dt>Storage classes</dt>
  *             <dd>
- *                <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval
- *                   storage class, the S3 Glacier Deep Archive storage class, the
- *                   S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier,
- *                   before you can retrieve the object you must first restore a copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this operation returns an
- *                      <code>InvalidObjectState</code> error. For information about restoring archived
- *                   objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived
- *                      Objects</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *                <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class,
+ *             the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the
+ *             S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a
+ *             copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this operation returns an <code>InvalidObjectState</code>
+ *             error. For information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in the
+ *               <i>Amazon S3 User Guide</i>.</p>
  *                <p>
  *                   <b>Directory buckets </b> -
- *                   Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
+ *             Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
  * Unsupported storage class values won't write a destination object and will respond with the HTTP status code <code>400 Bad Request</code>.</p>
  *             </dd>
  *             <dt>Encryption</dt>
  *             <dd>
- *                <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
- *                   should not be sent for the <code>GetObject</code> requests, if your object uses
- *                   server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side
- *                   encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side
- *                   encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your
- *                      <code>GetObject</code> requests for the object that uses these types of keys,
- *                   you’ll get an HTTP <code>400 Bad Request</code> error.</p>
+ *                <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent
+ *             for the <code>GetObject</code> requests, if your object uses server-side encryption with Amazon S3
+ *             managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or
+ *             dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in
+ *             your <code>GetObject</code> requests for the object that uses these types of keys, you’ll get an
+ *             HTTP <code>400 Bad Request</code> error.</p>
  *                <p>
  *                   <b>Directory buckets</b> -
- *                   For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more
+ *             For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more
  *          information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
  *             </dd>
  *             <dt>Overriding response header values through the request</dt>
  *             <dd>
  *                <p>There are times when you want to override certain response header values of a
- *                      <code>GetObject</code> response. For example, you might override the
- *                      <code>Content-Disposition</code> response header value through your
- *                      <code>GetObject</code> request.</p>
- *                <p>You can override values for a set of response headers. These modified response
- *                   header values are included only in a successful response, that is, when the HTTP
- *                   status code <code>200 OK</code> is returned. The headers you can override using
- *                   the following query parameters in the request are a subset of the headers that
- *                   Amazon S3 accepts when you create an object. </p>
- *                <p>The response headers that you can override for the <code>GetObject</code>
- *                   response are <code>Cache-Control</code>, <code>Content-Disposition</code>,
- *                      <code>Content-Encoding</code>, <code>Content-Language</code>,
- *                      <code>Content-Type</code>, and <code>Expires</code>.</p>
- *                <p>To override values for a set of response headers in the <code>GetObject</code>
- *                   response, you can use the following query parameters in the request.</p>
+ *               <code>GetObject</code> response. For example, you might override the
+ *               <code>Content-Disposition</code> response header value through your <code>GetObject</code>
+ *             request.</p>
+ *                <p>You can override values for a set of response headers. These modified response header values
+ *             are included only in a successful response, that is, when the HTTP status code <code>200 OK</code>
+ *             is returned. The headers you can override using the following query parameters in the request are
+ *             a subset of the headers that Amazon S3 accepts when you create an object. </p>
+ *                <p>The response headers that you can override for the <code>GetObject</code> response are
+ *               <code>Cache-Control</code>, <code>Content-Disposition</code>, <code>Content-Encoding</code>,
+ *               <code>Content-Language</code>, <code>Content-Type</code>, and <code>Expires</code>.</p>
+ *                <p>To override values for a set of response headers in the <code>GetObject</code> response, you
+ *             can use the following query parameters in the request.</p>
  *                <ul>
  *                   <li>
  *                      <p>
@@ -179,9 +165,9 @@ declare const GetObjectCommand_base: {
  *                   </li>
  *                </ul>
  *                <note>
- *                   <p>When you use these parameters, you must sign the request by using either an
- *                      Authorization header or a presigned URL. These parameters cannot be used with
- *                      an unsigned (anonymous) request.</p>
+ *                   <p>When you use these parameters, you must sign the request by using either an Authorization
+ *               header or a presigned URL. These parameters cannot be used with an unsigned (anonymous)
+ *               request.</p>
  *                </note>
  *             </dd>
  *             <dt>HTTP Host header syntax</dt>
@@ -294,13 +280,12 @@ declare const GetObjectCommand_base: {
  *
  * @throws {@link InvalidObjectState} (client fault)
  *  <p>Object is archived and inaccessible until restored.</p>
- *          <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage
- *          class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access
- *          tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you
- *          must first restore a copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this
- *          operation returns an <code>InvalidObjectState</code> error. For information about restoring
- *          archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in
- *          the <i>Amazon S3 User Guide</i>.</p>
+ *          <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the
+ *       S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the
+ *       S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy
+ *       using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this operation returns an <code>InvalidObjectState</code> error. For
+ *       information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in the
+ *         <i>Amazon S3 User Guide</i>.</p>
  *
  * @throws {@link NoSuchKey} (client fault)
  *  <p>The specified key does not exist.</p>

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

@@ -30,8 +30,7 @@ declare const GetObjectLegalHoldCommand_base: {
  * <note>
  *             <p>This operation is not supported for directory buckets.</p>
  *          </note>
- *          <p>Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
- *          Objects</a>.</p>
+ *          <p>Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p>
  *          <p>This functionality is not supported for Amazon S3 on Outposts.</p>
  *          <p>The following action is related to <code>GetObjectLegalHold</code>:</p>
  *          <ul>

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

@@ -30,9 +30,9 @@ declare const GetObjectLockConfigurationCommand_base: {
  * <note>
  *             <p>This operation is not supported for directory buckets.</p>
  *          </note>
- *          <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p>
+ *          <p>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
+ *         <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p>
  *          <p>The following action is related to <code>GetObjectLockConfiguration</code>:</p>
  *          <ul>
  *             <li>

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

@@ -30,8 +30,7 @@ declare const GetObjectRetentionCommand_base: {
  * <note>
  *             <p>This operation is not supported for directory buckets.</p>
  *          </note>
- *          <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
- *          Objects</a>.</p>
+ *          <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p>
  *          <p>This functionality is not supported for Amazon S3 on Outposts.</p>
  *          <p>The following action is related to <code>GetObjectRetention</code>:</p>
  *          <ul>

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

@@ -30,16 +30,14 @@ declare const GetObjectTaggingCommand_base: {
  * <note>
  *             <p>This operation is not supported for directory buckets.</p>
  *          </note>
- *          <p>Returns the tag-set of an object. You send the GET request against the tagging
- *          subresource associated with the object.</p>
- *          <p>To use this operation, you must have permission to perform the
- *             <code>s3:GetObjectTagging</code> 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 <code>s3:GetObjectVersionTagging</code>
- *          action.</p>
- *          <p> By default, the bucket owner has this permission and can grant this permission to
- *          others.</p>
+ *          <p>Returns the tag-set of an object. You send the GET request against the tagging subresource
+ *       associated with the object.</p>
+ *          <p>To use this operation, you must have permission to perform the <code>s3:GetObjectTagging</code>
+ *       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
+ *         <code>s3:GetObjectVersionTagging</code> action.</p>
+ *          <p> By default, the bucket owner has this permission and can grant this permission to others.</p>
  *          <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
  *          <p>The following actions are related to <code>GetObjectTagging</code>:</p>
  *          <ul>

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

@@ -31,12 +31,11 @@ declare const GetObjectTorrentCommand_base: {
  * <note>
  *             <p>This operation is not supported for directory buckets.</p>
  *          </note>
- *          <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
- *          distributing large files.</p>
+ *          <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing
+ *       large files.</p>
  *          <note>
- *             <p>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.</p>
+ *             <p>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.</p>
  *          </note>
  *          <p>To use GET, you must have READ access to the object.</p>
  *          <p>This functionality is not supported for Amazon S3 on Outposts.</p>

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

@@ -30,25 +30,23 @@ declare const GetPublicAccessBlockCommand_base: {
  * <note>
  *             <p>This operation is not supported for directory buckets.</p>
  *          </note>
- *          <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use
- *          this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
- *          For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
- *             Policy</a>.</p>
+ *          <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this
+ *       operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission. For more information
+ *       about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
+ *       Policy</a>.</p>
  *          <important>
- *             <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
- *             an object, it checks the <code>PublicAccessBlock</code> configuration for both the
- *             bucket (or the bucket that contains the object) and the bucket owner's account. If the
- *                <code>PublicAccessBlock</code> settings are different between the bucket and the
- *             account, Amazon S3 uses the most restrictive combination of the bucket-level and
- *             account-level settings.</p>
+ *             <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it
+ *         checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that
+ *         contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> settings
+ *         are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the
+ *         bucket-level and account-level settings.</p>
  *          </important>
  *          <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>.</p>
  *          <p>The following operations are related to <code>GetPublicAccessBlock</code>:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block
- *                   Public Access</a>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a>
  *                </p>
  *             </li>
  *             <li>

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

@@ -27,33 +27,31 @@ declare const HeadBucketCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>You can use this operation to determine if a bucket exists and if you have permission to
- *          access it. The action returns a <code>200 OK</code> if the bucket exists and you have
- *          permission to access it.</p>
+ * <p>You can use this operation to determine if a bucket exists and if you have permission to access it.
+ *       The action returns a <code>200 OK</code> if the bucket exists and you have permission to access
+ *       it.</p>
  *          <note>
- *             <p>If the bucket does not exist or you do not have permission to access it, the
- *                <code>HEAD</code> request returns a generic <code>400 Bad Request</code>, <code>403
- *                Forbidden</code> or <code>404 Not Found</code> code. A message body is not included,
- *             so you cannot determine the exception beyond these HTTP response codes.</p>
+ *             <p>If the bucket does not exist or you do not have permission to access it, the <code>HEAD</code>
+ *         request returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> or <code>404 Not
+ *           Found</code> code. A message body is not included, so you cannot determine the exception beyond
+ *         these HTTP response codes.</p>
  *          </note>
  *          <dl>
  *             <dt>Authentication and authorization</dt>
  *             <dd>
  *                <p>
- *                   <b>General purpose buckets</b> - Request to public
- *                   buckets that grant the s3:ListBucket permission publicly do not need to be signed.
- *                   All other <code>HeadBucket</code> requests must be authenticated and signed by
- *                   using IAM credentials (access key ID and secret access key for the IAM
- *                   identities). All headers with the <code>x-amz-</code> prefix, including
- *                      <code>x-amz-copy-source</code>, must be signed. For more information, see
- *                      <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
+ *                   <b>General purpose buckets</b> - Request to public buckets that
+ *             grant the s3:ListBucket permission publicly do not need to be signed. All other
+ *               <code>HeadBucket</code> requests must be authenticated and signed by using IAM credentials
+ *             (access key ID and secret access key for the IAM identities). All headers with the
+ *               <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed. For more
+ *             information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
  *                <p>
- *                   <b>Directory buckets</b> - You must use IAM
- *                   credentials to authenticate and authorize your access to the
- *                      <code>HeadBucket</code> API operation, instead of using the temporary security
- *                   credentials through the <code>CreateSession</code> API operation.</p>
- *                <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your
- *                   behalf.</p>
+ *                   <b>Directory buckets</b> - You must use IAM credentials to
+ *             authenticate and authorize your access to the <code>HeadBucket</code> API operation, instead of
+ *             using the temporary security credentials through the <code>CreateSession</code> API
+ *             operation.</p>
+ *                <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.</p>
  *             </dd>
  *             <dt>Permissions</dt>
  *             <dd>
@@ -61,26 +59,26 @@ declare const HeadBucketCommand_base: {
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <b>General purpose bucket permissions</b> - To
- *                         use this operation, you must have permissions to perform the
- *                            <code>s3:ListBucket</code> action. The bucket owner has this permission
- *                         by default and can grant this permission to others. For more information
- *                         about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing access
- *                            permissions to your Amazon S3 resources</a> in the
- *                            <i>Amazon S3 User Guide</i>.</p>
+ *                         <b>General purpose bucket permissions</b> - To use this
+ *                 operation, you must have permissions to perform the <code>s3:ListBucket</code> action. The
+ *                 bucket owner has this permission by default and can grant this permission to others. For more
+ *                 information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing access permissions to your
+ *                   Amazon S3 resources</a> in the <i>Amazon S3 User Guide</i>.</p>
  *                   </li>
  *                   <li>
  *                      <p>
- *                         <b>Directory bucket permissions</b> -
- *                         You must have the <b>
+ *                         <b>Directory bucket permissions</b> - You must have the
+ *                   <b>
  *                            <code>s3express:CreateSession</code>
  *                         </b> permission in the
- *                            <code>Action</code> element of a policy. By default, the session is in
- *                         the <code>ReadWrite</code> mode. If you want to restrict the access, you can
- *                         explicitly set the <code>s3express:SessionMode</code> condition key to
- *                            <code>ReadOnly</code> on the bucket.</p>
- *                      <p>For more information about example bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services Identity and Access Management (IAM) identity-based policies for
- *                            S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *                   <code>Action</code> element of a policy. By default, the session is in the
+ *                   <code>ReadWrite</code> mode. If you want to restrict the access, you can explicitly set the
+ *                   <code>s3express:SessionMode</code> condition key to <code>ReadOnly</code> on the
+ *                 bucket.</p>
+ *                      <p>For more information about example bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example
+ *                   bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services
+ *                   Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the
+ *                   <i>Amazon S3 User Guide</i>.</p>
  *                   </li>
  *                </ul>
  *             </dd>