@aws-sdk/client-s3 3.460.0 → 3.461.0

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

@@ -23,104 +23,117 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
 }
 /**
  * @public
- * <p>Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a
+ * <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
  *          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>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. To constrain the bucket creation to a
- *          specific Region, you can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketConfiguration.html">
- *                <code>LocationConstraint</code>
- *             </a> condition key. 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>
+ *          <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>
  *          <note>
- *             <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint,
- *             the request goes to the <code>us-east-1</code> Region. Accordingly, 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>.</p>
+ *             <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>
  *          </note>
  *          <dl>
  *             <dt>Permissions</dt>
  *             <dd>
- *                <p>In addition to <code>s3:CreateBucket</code>, the following permissions are
- *                   required when your <code>CreateBucket</code> request includes specific
- *                   headers:</p>
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <b>Access control lists (ACLs)</b> - If your
- *                            <code>CreateBucket</code> request specifies access control list (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 for the
- *                            <code>CreateBucket</code> request is private or if the request doesn't
- *                         specify any ACLs, only <code>s3:CreateBucket</code> permission is needed.
- *                      </p>
- *                   </li>
- *                   <li>
- *                      <p>
- *                         <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>
+ *                         <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>
  *                   </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. By
- *                         default, <code>ObjectOwnership</code> is set to
- *                            <code>BucketOWnerEnforced</code> and ACLs are disabled. We recommend
- *                         keeping ACLs disabled, except in uncommon use cases where you must control
- *                         access for each object individually. If you want to change the
- *                            <code>ObjectOwnership</code> setting, you can use the
- *                            <code>x-amz-object-ownership</code> header in your
- *                            <code>CreateBucket</code> request to set the <code>ObjectOwnership</code>
- *                         setting of your choice. For more information about S3 Object Ownership, 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>
- *                   </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. 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. By default, all
- *                         Block Public Access settings are enabled for new buckets. To avoid
- *                         inadvertent exposure of your resources, we recommend keeping the S3 Block
- *                         Public Access settings enabled. For more information about S3 Block Public
- *                         Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Blocking
- *                            public access to your Amazon S3 storage </a> in the
- *                            <i>Amazon S3 User Guide</i>. </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>
  *                   </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>
- *          <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>
  *          <p>The following operations are related to <code>CreateBucket</code>:</p>
  *          <ul>
  *             <li>
@@ -144,7 +157,15 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
  *   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-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-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" || "ap-south-2" || "eu-south-2",
+ *     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",
@@ -181,39 +202,39 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @example To create a bucket
+ * @example To create a bucket in a specific region
  * ```javascript
- * // The following example creates a bucket.
+ * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   "Bucket": "examplebucket",
+ *   "CreateBucketConfiguration": {
+ *     "LocationConstraint": "eu-west-1"
+ *   }
  * };
  * const command = new CreateBucketCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "Location": "/examplebucket"
+ *   "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
  * }
  * *\/
- * // example id: to-create-a-bucket--1472851826060
+ * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
  * ```
  *
- * @example To create a bucket in a specific region
+ * @example To create a bucket
  * ```javascript
- * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
+ * // The following example creates a bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "CreateBucketConfiguration": {
- *     "LocationConstraint": "eu-west-1"
- *   }
+ *   "Bucket": "examplebucket"
  * };
  * const command = new CreateBucketCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
+ *   "Location": "/examplebucket"
  * }
  * *\/
- * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
+ * // example id: to-create-a-bucket--1472851826060
  * ```
  *
  */