@nocobase/plugin-file-manager 0.17.0-alpha.7 → 0.18.0-alpha.2

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketCommand.d.ts

@@ -25,6 +25,41 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {
  * @public
  * <p>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.</p>
+ *          <note>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <b>Directory buckets</b> - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.</p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
+ *                      </code>. Virtual-hosted-style requests aren't 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>
+ *                </li>
+ *             </ul>
+ *          </note>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <b>General purpose bucket permissions</b> - You must have the <code>s3:DeleteBucket</code> permission on the specified bucket in a policy.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <b>Directory bucket permissions</b> - You must have the <code>s3express:DeleteBucket</code> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *                   </li>
+ *                </ul>
+ *             </dd>
+ *             <dt>HTTP Host header syntax</dt>
+ *             <dd>
+ *                <p>
+ *                   <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
+ *             </dd>
+ *          </dl>
  *          <p>The following operations are related to <code>DeleteBucket</code>:</p>
  *          <ul>
  *             <li>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketCorsCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Deletes the <code>cors</code> configuration information set for the bucket.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the <code>cors</code> configuration information set for the bucket.</p>
  *          <p>To use this operation, you must have permission to perform the
  *             <code>s3:PutBucketCORS</code> action. The bucket owner has this permission by default
  *          and can grant this permission to others. </p>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketEncryptionCommand.d.ts

@@ -23,9 +23,12 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>This implementation of the DELETE action resets the default encryption for the
- *          bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the
- *          bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>This implementation of the DELETE action resets the default encryption for the bucket as
+ *          server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket
+ *          default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
  *          in the <i>Amazon S3 User Guide</i>.</p>
  *          <p>To use this operation, you must have permissions to perform the
  *             <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
 }
 /**
  * @public
- * <p>Deletes the S3 Intelligent-Tiering configuration from the specified bucket.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the S3 Intelligent-Tiering configuration from the specified bucket.</p>
  *          <p>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 performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
  *          <p>The S3 Intelligent-Tiering storage class is  the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and 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.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad
 }
 /**
  * @public
- * <p>Deletes an inventory configuration (identified by the inventory ID) from the
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes an inventory configuration (identified by the inventory ID) from the
  *          bucket.</p>
  *          <p>To use this operation, you must have permissions to perform the
  *             <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketLifecycleCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>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.</p>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat
 }
 /**
  * @public
- * <p>Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>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.</p>
  *          <p> To use this operation, you must have permissions to perform the

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe
 }
 /**
  * @public
- * <p>Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
  *          must have the <code>s3:PutBucketOwnershipControls</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>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketPolicyCommand.d.ts

@@ -23,25 +23,54 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>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
- *             <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong to the
- *          bucket owner's account to use this operation. </p>
- *          <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403
- *             Access Denied</code> 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 <code>405 Method Not
- *             Allowed</code> error. </p>
- *          <important>
- *             <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
- *             buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
- *                <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
- *                <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
- *             denies the root principal's access. Bucket owner root principals can only be blocked from performing
- *             these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
- *          </important>
- *          <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and
- *             UserPolicies</a>. </p>
+ * <p>Deletes the
+ *          policy of a specified bucket.</p>
+ *          <note>
+ *             <p>
+ *                <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
+ *                </code>. Virtual-hosted-style requests aren't 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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>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 both have the
+ *                   <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong to the
+ *                   bucket owner's account in order to use this operation.</p>
+ *                <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403
+ *                   Access Denied</code> 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 <code>405 Method Not
+ *                      Allowed</code> error.</p>
+ *                <important>
+ *                   <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
+ *                      buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
+ *                      <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
+ *                      <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
+ *                      denies the root principal's access. Bucket owner root principals can only be blocked
+ *                      from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
+ *                      policies.</p>
+ *                </important>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <b>General purpose bucket permissions</b> - The <code>s3:DeleteBucketPolicy</code> permission is required in a policy.
+ *                         For more information about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
+ *                            Policies</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <code>s3express:DeleteBucketPolicy</code> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *                   </li>
+ *                </ul>
+ *             </dd>
+ *             <dt>HTTP Host header syntax</dt>
+ *             <dd>
+ *                <p>
+ *                   <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
+ *             </dd>
+ *          </dl>
  *          <p>The following operations are related to <code>DeleteBucketPolicy</code>
  *          </p>
  *          <ul>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketReplicationCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p> Deletes the replication configuration from the bucket.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p> Deletes the replication configuration from the bucket.</p>
  *          <p>To use this operation, you must have permissions to perform the
  *             <code>s3:PutReplicationConfiguration</code> action. The bucket owner has these
  *          permissions by default and can grant it to others. For more information about permissions,

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketTaggingCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Deletes the tags from the bucket.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the tags from the bucket.</p>
  *          <p>To use this operation, you must have permission to perform the
  *             <code>s3:PutBucketTagging</code> action. By default, the bucket owner has this
  *          permission and can grant this permission to others. </p>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketWebsiteCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>This action removes the website configuration for a bucket. Amazon S3 returns a <code>200
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>This action removes the website configuration for a bucket. Amazon S3 returns a <code>200
  *             OK</code> response upon successfully deleting a website configuration on the specified
  *          bucket. You will get a <code>200 OK</code> response if the website configuration you are
  *          trying to delete does not exist on the bucket. Amazon S3 returns a <code>404</code> response if

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteObjectCommand.d.ts

@@ -23,24 +23,96 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
 }
 /**
  * @public
- * <p>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.</p>
- *          <p>To remove a specific version, 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, <code>x-amz-delete-marker</code>, to true. </p>
+ * <p>Removes an object from a bucket. The behavior depends on the bucket's versioning state: </p>
+ *          <ul>
+ *             <li>
+ *                <p>If versioning is enabled, the operation 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.</p>
+ *             </li>
+ *             <li>
+ *                <p>If versioning is suspended or not enabled, the operation permanently deletes the object.</p>
+ *             </li>
+ *          </ul>
+ *          <note>
+ *             <ul>
+ *                <li>
+ *                   <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>
+ *                </li>
+ *                <li>
+ *                   <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>
+ *                </li>
+ *             </ul>
+ *          </note>
+ *          <p>To remove a specific version, you must use the <code>versionId</code> query parameter. Using this
+ *          query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3
+ *          sets the response header <code>x-amz-delete-marker</code> to true. </p>
  *          <p>If the object you want to delete is in a bucket where the bucket versioning
  *          configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request
  *          header in the DELETE <code>versionId</code> request. Requests that include
- *             <code>x-amz-mfa</code> must use HTTPS. </p>
- *          <p> For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a>. To see sample
+ *          <code>x-amz-mfa</code> must use HTTPS. For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a> in the <i>Amazon S3
+ *                User Guide</i>. To see sample
  *          requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample
  *             Request</a>. </p>
- *          <p>You can delete objects by explicitly calling DELETE Object or configure its lifecycle
- *             (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) to enable Amazon S3 to remove them for you. If you want to block
+ *          <note>
+ *             <p>
+ *                <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>You can delete objects by explicitly calling DELETE Object or calling
+ *          (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) 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 <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and
- *             <code>s3:PutLifeCycleConfiguration</code> actions. </p>
+ *          <code>s3:PutLifeCycleConfiguration</code> actions. </p>
+ *          <note>
+ *             <p>
+ *                <b>Directory buckets</b> - S3 Lifecycle is not supported by directory buckets.</p>
+ *          </note>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your
+ *                         <code>DeleteObjects</code> request includes specific headers.</p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>
+ *                               <b>
+ *                                  <code>s3:DeleteObject</code>
+ *                               </b> - To delete an object from a bucket, you must always have the <code>s3:DeleteObject</code> permission.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>
+ *                               <b>
+ *                                  <code>s3:DeleteObjectVersion</code>
+ *                               </b> - To delete a specific version of an object from a versiong-enabled bucket, you must have the <code>s3:DeleteObjectVersion</code> permission.</p>
+ *                         </li>
+ *                      </ul>
+ *                   </li>
+ *                   <li>
+ *                      <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>
+ *             </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 action is related to <code>DeleteObject</code>:</p>
  *          <ul>
  *             <li>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteObjectTaggingCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
 }
 /**
  * @public
- * <p>Removes the entire tag set from the specified object. For more information about
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Removes the entire tag set from the specified object. For more information about
  *          managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object Tagging</a>.</p>
  *          <p>To use this operation, you must have permission to perform the
  *             <code>s3:DeleteObjectTagging</code> action.</p>

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteObjectsCommand.d.ts

@@ -23,29 +23,104 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
 }
 /**
  * @public
- * <p>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
+ * <p>This operation enables you to delete multiple objects from a bucket using a single HTTP
+ *          request. If you know the object keys that you want to delete, then this operation provides a
  *          suitable alternative to sending individual delete requests, reducing per-request
  *          overhead.</p>
- *          <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you
+ *          <p>The request can contain 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.
+ *          delete operation and returns the result of that delete, success or failure, in the response.
  *          Note that if the object specified in the request is not found, Amazon S3 returns the result as
  *          deleted.</p>
- *          <p> 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
+ *          <note>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets.</p>
+ *                </li>
+ *                <li>
+ *                   <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>
+ *                </li>
+ *             </ul>
+ *          </note>
+ *          <p>The operation supports two modes for the response: verbose and quiet. By default, the
+ *          operation uses verbose mode in which the response includes the result of deletion of each key
+ *          in your request. In quiet mode the response includes only keys where the delete operation
+ *          encountered an error. For a successful deletion in a quiet mode, the operation does not return any information
  *          about the delete in the response body.</p>
  *          <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA
- *             Delete</a>.</p>
- *          <p>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.</p>
+ *          entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete">MFA
+ *             Delete</a> in the <i>Amazon S3
+ *                User Guide</i>.</p>
+ *          <note>
+ *             <p>
+ *                <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p>
+ *          </note>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your
+ *                         <code>DeleteObjects</code> request includes specific headers.</p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>
+ *                               <b>
+ *                                  <code>s3:DeleteObject</code>
+ *                               </b> - To delete an object from a bucket, you must always specify the <code>s3:DeleteObject</code> permission.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>
+ *                               <b>
+ *                                  <code>s3:DeleteObjectVersion</code>
+ *                               </b> - To delete a specific version of an object from a versiong-enabled bucket, you must specify the <code>s3:DeleteObjectVersion</code> permission.</p>
+ *                         </li>
+ *                      </ul>
+ *                   </li>
+ *                   <li>
+ *                      <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>
+ *             </dd>
+ *             <dt>Content-MD5 request header</dt>
+ *             <dd>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <b>General purpose bucket</b> - The Content-MD5 request 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.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <b>Directory bucket</b> - The Content-MD5 request header or a additional checksum request header
+ *                      (including <code>x-amz-checksum-crc32</code>, <code>x-amz-checksum-crc32c</code>, <code>x-amz-checksum-sha1</code>, or
+ *                      <code>x-amz-checksum-sha256</code>) is required for all Multi-Object Delete requests.</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 operations are related to <code>DeleteObjects</code>:</p>
  *          <ul>
  *             <li>
@@ -130,18 +205,20 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @example To delete multiple objects from a versioned bucket
+ * @example To delete multiple object versions from a versioned bucket
  * ```javascript
- * // The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
+ * // The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.
  * const input = {
  *   "Bucket": "examplebucket",
  *   "Delete": {
  *     "Objects": [
  *       {
- *         "Key": "objectkey1"
+ *         "Key": "HappyFace.jpg",
+ *         "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
  *       },
  *       {
- *         "Key": "objectkey2"
+ *         "Key": "HappyFace.jpg",
+ *         "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
  *       }
  *     ],
  *     "Quiet": false
@@ -153,35 +230,31 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
  * {
  *   "Deleted": [
  *     {
- *       "DeleteMarker": "true",
- *       "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
- *       "Key": "objectkey1"
+ *       "Key": "HappyFace.jpg",
+ *       "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
  *     },
  *     {
- *       "DeleteMarker": "true",
- *       "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
- *       "Key": "objectkey2"
+ *       "Key": "HappyFace.jpg",
+ *       "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
+ * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
  * ```
  *
- * @example To delete multiple object versions from a versioned bucket
+ * @example To delete multiple objects from a versioned bucket
  * ```javascript
- * // The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.
+ * // The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
  * const input = {
  *   "Bucket": "examplebucket",
  *   "Delete": {
  *     "Objects": [
  *       {
- *         "Key": "HappyFace.jpg",
- *         "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
+ *         "Key": "objectkey1"
  *       },
  *       {
- *         "Key": "HappyFace.jpg",
- *         "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
+ *         "Key": "objectkey2"
  *       }
  *     ],
  *     "Quiet": false
@@ -193,17 +266,19 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
  * {
  *   "Deleted": [
  *     {
- *       "Key": "HappyFace.jpg",
- *       "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
+ *       "DeleteMarker": "true",
+ *       "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
+ *       "Key": "objectkey1"
  *     },
  *     {
- *       "Key": "HappyFace.jpg",
- *       "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
+ *       "DeleteMarker": "true",
+ *       "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
+ *       "Key": "objectkey2"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
+ * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
  * ```
  *
  */

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeletePublicAccessBlockCommand.d.ts

@@ -23,7 +23,10 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this
  *          operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For
  *          more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
  *             Access Permissions to Your Amazon S3 Resources</a>.</p>