@nocobase/plugin-file-manager 1.6.0-beta.3 → 1.6.0-beta.4

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

@@ -1,139 +1,147 @@
-import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
-import { Command as $Command } from "@smithy/smithy-client";
-import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { CreateBucketOutput, CreateBucketRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- *
- * The input for {@link CreateBucketCommand}.
- */
 export interface CreateBucketCommandInput extends CreateBucketRequest {
 }
-/**
- * @public
- *
- * The output of {@link CreateBucketCommand}.
- */
 export interface CreateBucketCommandOutput extends CreateBucketOutput, __MetadataBearer {
 }
 /**
- * @public
- * <note>
- *             <p>This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">
- *                   <code>CreateBucket</code>
- *                </a>.</p>
- *          </note>
- *          <p>Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a
+ * <p>Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a
  *          valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to
  *          create buckets. By creating the bucket, you become the bucket owner.</p>
- *          <p>There are two types of buckets: general purpose buckets and directory buckets. For more
- *          information about these bucket types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and
- *             working with Amazon S3 buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *          <p>Not every string is an acceptable bucket name. For information about bucket naming
+ *          restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket naming rules</a>.</p>
+ *          <p>If you want to create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">Create Bucket</a>. </p>
+ *          <p>By default, the bucket is created in the US East (N. Virginia) Region. You can
+ *          optionally specify a Region in the request body. You might choose a Region to optimize
+ *          latency, minimize costs, or address regulatory requirements. For example, if you reside in
+ *          Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)
+ *          Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a
+ *          bucket</a>.</p>
  *          <note>
- *             <ul>
- *                <li>
- *                   <p>
- *                      <b>General purpose buckets</b> - If you send your <code>CreateBucket</code> request to the <code>s3.amazonaws.com</code> global endpoint,
- *                   the request goes to the <code>us-east-1</code> Region. So the signature
- *                   calculations in Signature Version 4 must use <code>us-east-1</code> as the Region, even
- *                   if the location constraint in the request specifies another Region where the bucket is
- *                   to be created. If you create a bucket in a Region other than US East (N. Virginia), your
- *                   application must be able to handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
- *                      buckets</a> in the <i>Amazon S3 User Guide</i>.</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>
+ *             <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint,
+ *             the request goes to the us-east-1 Region. Accordingly, the signature calculations in
+ *             Signature Version 4 must use us-east-1 as the Region, even if the location constraint in
+ *             the request specifies another Region where the bucket is to be created. If you create a
+ *             bucket in a Region other than US East (N. Virginia), your application must be able to
+ *             handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of buckets</a>.</p>
  *          </note>
- *          <dl>
- *             <dt>Permissions</dt>
- *             <dd>
+ *          <p>
+ *             <b>Access control lists (ACLs)</b>
+ *          </p>
+ *          <p>When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or
+ *          groups that should be granted specific permissions on the bucket.</p>
+ *          <important>
+ *             <p>If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and
+ *             specifies a bucket ACL that provides access to an external Amazon Web Services account, your request
+ *             fails with a <code>400</code> error and returns the
+ *                <code>InvalidBucketAclWithObjectOwnership</code> error code. For more information,
+ *             see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object
+ *                ownership</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *          </important>
+ *          <p>There are two ways to grant the appropriate permissions using the request headers.</p>
+ *          <ul>
+ *             <li>
+ *                <p>Specify a canned ACL using the <code>x-amz-acl</code> request header. Amazon S3
+ *                supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each
+ *                canned ACL has a predefined set of grantees and permissions. For more information,
+ *                see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>Specify access permissions explicitly using the <code>x-amz-grant-read</code>,
+ *                   <code>x-amz-grant-write</code>, <code>x-amz-grant-read-acp</code>,
+ *                   <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code>
+ *                headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For
+ *                more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html">Access control list
+ *                   (ACL) overview</a>.</p>
+ *                <p>You specify each grantee as a type=value pair, where the type is one of the
+ *                following:</p>
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <b>General purpose bucket permissions</b> - In addition to the <code>s3:CreateBucket</code> permission, the following permissions are
- *                      required in a policy when your <code>CreateBucket</code> request includes specific
- *                      headers: </p>
- *                      <ul>
- *                         <li>
- *                            <p>
- *                               <b>Access control lists (ACLs)</b> - In your <code>CreateBucket</code> request, if you specify an access control list (ACL)
- *                               and set it to <code>public-read</code>, <code>public-read-write</code>,
- *                               <code>authenticated-read</code>, or if you explicitly specify any other custom ACLs, both <code>s3:CreateBucket</code> and
- *                               <code>s3:PutBucketAcl</code> permissions are required. In your <code>CreateBucket</code> request, if you set the ACL to <code>private</code>,
- *                               or if you don't specify any ACLs, only the <code>s3:CreateBucket</code> permission is required.
- *                            </p>
- *                         </li>
- *                         <li>
- *                            <p>
- *                               <b>Object Lock</b> - In your
- *                               <code>CreateBucket</code> request, if you set
- *                               <code>x-amz-bucket-object-lock-enabled</code> to true, the
- *                               <code>s3:PutBucketObjectLockConfiguration</code> and
- *                               <code>s3:PutBucketVersioning</code> permissions are required.</p>
- *                         </li>
- *                         <li>
- *                            <p>
- *                               <b>S3 Object Ownership</b> - If your
- *                               <code>CreateBucket</code> request includes the
- *                               <code>x-amz-object-ownership</code> header, then the
- *                               <code>s3:PutBucketOwnershipControls</code> permission is required.</p>
- *                            <important>
- *                               <p>If your <code>CreateBucket</code> request sets <code>BucketOwnerEnforced</code> for
- *                                  Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external
- *                                  Amazon Web Services account, your request fails with a <code>400</code> error and returns the
- *                                  <code>InvalidBucketAcLWithObjectOwnership</code> error code. For more information,
- *                                  see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html">Setting Object
- *                                     Ownership on an existing bucket </a> in the <i>Amazon S3 User Guide</i>.
- *                               </p>
- *                            </important>
- *                         </li>
- *                         <li>
- *                            <p>
- *                               <b>S3 Block Public Access</b> - If your
- *                               specific use case requires granting public access to your S3 resources, you
- *                               can disable Block Public Access. Specifically, you can create a new bucket with Block
- *                               Public Access enabled, then separately call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">
- *                                  <code>DeletePublicAccessBlock</code>
- *                               </a> API. To use this operation, you must have the
- *                               <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about S3 Block Public
- *                               Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking
- *                                  public access to your Amazon S3 storage </a> in the
- *                               <i>Amazon S3 User Guide</i>. </p>
- *                         </li>
- *                      </ul>
+ *                         <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <code>uri</code> – if you are granting permissions to a predefined
+ *                      group</p>
  *                   </li>
  *                   <li>
  *                      <p>
- *                         <b>Directory bucket permissions</b> - You must have the <code>s3express:CreateBucket</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>
- *                      <important>
- *                         <p>The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets.
- *                         For directory buckets, all Block Public Access settings are enabled at the bucket level and S3
- *                         Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can't be modified.
- *                      </p>
- *                         <p>For more information about permissions for creating and working with
- *                            directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>.
- *                            For more information about supported S3 features for directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features">Features of S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
- *                      </important>
+ *                         <code>emailAddress</code> – if the value specified is the email address of
+ *                      an Amazon Web Services account</p>
+ *                      <note>
+ *                         <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
+ *                         <ul>
+ *                            <li>
+ *                               <p>US East (N. Virginia)</p>
+ *                            </li>
+ *                            <li>
+ *                               <p>US West (N. California)</p>
+ *                            </li>
+ *                            <li>
+ *                               <p> US West (Oregon)</p>
+ *                            </li>
+ *                            <li>
+ *                               <p> Asia Pacific (Singapore)</p>
+ *                            </li>
+ *                            <li>
+ *                               <p>Asia Pacific (Sydney)</p>
+ *                            </li>
+ *                            <li>
+ *                               <p>Asia Pacific (Tokyo)</p>
+ *                            </li>
+ *                            <li>
+ *                               <p>Europe (Ireland)</p>
+ *                            </li>
+ *                            <li>
+ *                               <p>South America (São Paulo)</p>
+ *                            </li>
+ *                         </ul>
+ *                         <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p>
+ *                      </note>
  *                   </li>
  *                </ul>
- *             </dd>
- *             <dt>HTTP Host header syntax</dt>
- *             <dd>
+ *                <p>For example, the following <code>x-amz-grant-read</code> header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:</p>
+ *                <p>
+ *                   <code>x-amz-grant-read: id="11112222333", id="444455556666" </code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <note>
+ *             <p>You can use either a canned ACL or specify access permissions explicitly. You cannot
+ *             do both.</p>
+ *          </note>
+ *
+ *          <p>
+ *             <b>Permissions</b>
+ *          </p>
+ *          <p>In addition to <code>s3:CreateBucket</code>, the following permissions are required when your CreateBucket includes specific headers:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>ACLs</b> - If your <code>CreateBucket</code> request specifies ACL permissions and the ACL is public-read, public-read-write,
+ *                authenticated-read, or if you specify access permissions explicitly through any other ACL, both
+ *                <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions are needed. If the ACL the
+ *                <code>CreateBucket</code> request is private or doesn't specify any ACLs, only <code>s3:CreateBucket</code> permission is needed. </p>
+ *             </li>
+ *             <li>
  *                <p>
- *                   <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
- *             </dd>
- *          </dl>
+ *                   <b>Object Lock</b> - If
+ *                   <code>ObjectLockEnabledForBucket</code> is set to true in your
+ *                   <code>CreateBucket</code> request,
+ *                   <code>s3:PutBucketObjectLockConfiguration</code> and
+ *                   <code>s3:PutBucketVersioning</code> permissions are required.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>S3 Object Ownership</b> - If your CreateBucket
+ *                request includes the the <code>x-amz-object-ownership</code> header,
+ *                   <code>s3:PutBucketOwnershipControls</code> permission is required.</p>
+ *             </li>
+ *          </ul>
  *          <p>The following operations are related to <code>CreateBucket</code>:</p>
  *          <ul>
  *             <li>
@@ -153,108 +161,23 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
  * import { S3Client, CreateBucketCommand } from "@aws-sdk/client-s3"; // ES Modules import
  * // const { S3Client, CreateBucketCommand } = require("@aws-sdk/client-s3"); // CommonJS import
  * const client = new S3Client(config);
- * const input = { // CreateBucketRequest
- *   ACL: "private" || "public-read" || "public-read-write" || "authenticated-read",
- *   Bucket: "STRING_VALUE", // required
- *   CreateBucketConfiguration: { // CreateBucketConfiguration
- *     LocationConstraint: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ca-central-1" || "cn-north-1" || "cn-northwest-1" || "EU" || "eu-central-1" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "me-south-1" || "sa-east-1" || "us-east-2" || "us-gov-east-1" || "us-gov-west-1" || "us-west-1" || "us-west-2",
- *     Location: { // LocationInfo
- *       Type: "AvailabilityZone",
- *       Name: "STRING_VALUE",
- *     },
- *     Bucket: { // BucketInfo
- *       DataRedundancy: "SingleAvailabilityZone",
- *       Type: "Directory",
- *     },
- *   },
- *   GrantFullControl: "STRING_VALUE",
- *   GrantRead: "STRING_VALUE",
- *   GrantReadACP: "STRING_VALUE",
- *   GrantWrite: "STRING_VALUE",
- *   GrantWriteACP: "STRING_VALUE",
- *   ObjectLockEnabledForBucket: true || false,
- *   ObjectOwnership: "BucketOwnerPreferred" || "ObjectWriter" || "BucketOwnerEnforced",
- * };
  * const command = new CreateBucketCommand(input);
  * const response = await client.send(command);
- * // { // CreateBucketOutput
- * //   Location: "STRING_VALUE",
- * // };
- *
  * ```
  *
- * @param CreateBucketCommandInput - {@link CreateBucketCommandInput}
- * @returns {@link CreateBucketCommandOutput}
  * @see {@link CreateBucketCommandInput} for command's `input` shape.
  * @see {@link CreateBucketCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
- * @throws {@link BucketAlreadyExists} (client fault)
- *  <p>The requested bucket name is not available. The bucket namespace is shared by all users
- *          of the system. Select a different name and try again.</p>
- *
- * @throws {@link BucketAlreadyOwnedByYou} (client fault)
- *  <p>The bucket you tried to create already exists, and you own it. Amazon S3 returns this error
- *          in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you
- *          re-create an existing bucket that you already own in the North Virginia Region, Amazon S3
- *          returns 200 OK and resets the bucket access control lists (ACLs).</p>
- *
- * @throws {@link S3ServiceException}
- * <p>Base exception class for all service exceptions from S3 service.</p>
- *
- * @example To create a bucket in a specific region
- * ```javascript
- * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
- * const input = {
- *   "Bucket": "examplebucket",
- *   "CreateBucketConfiguration": {
- *     "LocationConstraint": "eu-west-1"
- *   }
- * };
- * const command = new CreateBucketCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
- * }
- * *\/
- * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
- * ```
- *
- * @example To create a bucket
- * ```javascript
- * // The following example creates a bucket.
- * const input = {
- *   "Bucket": "examplebucket"
- * };
- * const command = new CreateBucketCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "Location": "/examplebucket"
- * }
- * *\/
- * // example id: to-create-a-bucket--1472851826060
- * ```
- *
  */
 export declare class CreateBucketCommand extends $Command<CreateBucketCommandInput, CreateBucketCommandOutput, S3ClientResolvedConfig> {
     readonly input: CreateBucketCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
     constructor(input: CreateBucketCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBucketCommandInput, CreateBucketCommandOutput>;
-    /**
-     * @internal
-     */
     private serialize;
-    /**
-     * @internal
-     */
     private deserialize;
 }