End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
WarningEnd of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName . Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName .
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
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.
There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide .
NoteCreateBucket request to the s3.amazonaws.com global endpoint, the request goes to the us-east-1 Region. So 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 Virtual hosting of buckets in the Amazon S3 User Guide .Permissions
General purpose bucket permissions - In addition to the s3:CreateBucket permission, the following permissions are required in a policy when your CreateBucket request includes specific headers:
CreateBucket request, if you specify an access control list (ACL) and set it to public-read , public-read-write , authenticated-read , or if you explicitly specify any other custom ACLs, both s3:CreateBucket and s3:PutBucketAcl permissions are required. In your CreateBucket request, if you set the ACL to private , or if you donât specify any ACLs, only the s3:CreateBucket permission is required.CreateBucket request, if you set x-amz-bucket-object-lock-enabled to true, the s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.CreateBucket request includes the x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is required.To set an ACL on a bucket as part of a CreateBucket request, you must explicitly set S3 Object Ownership for the bucket to a different value than the default, BucketOwnerEnforced . Additionally, if your desired bucket ACL grants public access, you must first create the bucket (without the bucket ACL) and then explicitly disable Block Public Access on the bucket before using PutBucketAcl to set the ACL. If you try to create a bucket with a public ACL, the request will fail. For the majority of modern use cases in S3, we recommend that you keep all Block Public Access settings enabled and keep ACLs disabled. If you would like to share data with users outside of your account, you can use bucket policies as needed. For more information, see Controlling ownership of objects and disabling ACLs for your bucket and Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide .
DeletePublicAccessBlock https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html`__ API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide .Directory bucket permissions - You must have the s3express:CreateBucket 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 Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide .
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. For more information about permissions for creating and working with directory buckets, see
Directory bucketsin the
Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see
Features of S3 Express One Zonein the
Amazon S3 User Guide.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is s3express-control.*region-code* .amazonaws.com .
The following operations are related to CreateBucket :
See also: AWS API Documentation
Synopsis¶create-bucket [--acl <value>] --bucket <value> [--create-bucket-configuration <value>] [--grant-full-control <value>] [--grant-read <value>] [--grant-read-acp <value>] [--grant-write <value>] [--grant-write-acp <value>] [--object-lock-enabled-for-bucket | --no-object-lock-enabled-for-bucket] [--object-ownership <value>] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]Options¶
--acl (string)
The canned ACL to apply to the bucket.
NoteThis functionality is not supported for directory buckets.Possible values:
privatepublic-readpublic-read-writeauthenticated-read
--bucket (string)
The name of the bucket to create.
General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide .
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format
https://s3express-control.*region-code* .amazonaws.com/*bucket-name* `` . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format `` *bucket-base-name* --*zone-id* --x-s3(for example, `` DOC-EXAMPLE-BUCKET âusw2-az1 âx-s3`` ). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
--create-bucket-configuration (structure)
The configuration information for the bucket.
LocationConstraint -> (string)
Specifies the Region where the bucket will be created. 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.
If you donât specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value
EUwill create a bucket ineu-west-1.For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints .
NoteThis functionality is not supported for directory buckets.Location -> (structure)
Specifies the location where the bucket will be created.
Directory bucketsNoteThis functionality is only supported by directory buckets.- The location type is Availability Zone or Local Zone. To use the Local Zone location type, your account must be enabled for Local Zones. Otherwise, you get an HTTP
403 Forbiddenerror with the error code
AccessDenied. To learn more, see
Enable accounts for Local Zonesin the
Amazon S3 User Guide.
Type -> (string)
The type of location where the bucket will be created.
Name -> (string)
The name of the location where the bucket will be created.
For directory buckets, the name of the location is the Zone ID of the Availability Zone (AZ) or Local Zone (LZ) where the bucket will be created. An example AZ ID value is
usw2-az1.Bucket -> (structure)
Specifies the information about the bucket that will be created.
NoteThis functionality is only supported by directory buckets.DataRedundancy -> (string)
The number of Zone (Availability Zone or Local Zone) thatâs used for redundancy for the bucket.
Type -> (string)
The type of bucket.
Tags -> (list)
An array of tags that you can apply to the bucket that youâre creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.
(structure)
A container of a key value name pair.
Key -> (string)
Name of the object key.
Value -> (string)
Value of the tag.
Shorthand Syntax:
LocationConstraint=string,Location={Type=string,Name=string},Bucket={DataRedundancy=string,Type=string},Tags=[{Key=string,Value=string},{Key=string,Value=string}]
JSON Syntax:
{
"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"|"ap-southeast-4"|"ap-southeast-5"|"ca-central-1"|"cn-north-1"|"cn-northwest-1"|"EU"|"eu-central-1"|"eu-central-2"|"eu-north-1"|"eu-south-1"|"eu-south-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"il-central-1"|"me-central-1"|"me-south-1"|"sa-east-1"|"us-east-2"|"us-gov-east-1"|"us-gov-west-1"|"us-west-1"|"us-west-2",
"Location": {
"Type": "AvailabilityZone"|"LocalZone",
"Name": "string"
},
"Bucket": {
"DataRedundancy": "SingleAvailabilityZone"|"SingleLocalZone",
"Type": "Directory"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
]
}
--grant-full-control (string)
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
NoteThis functionality is not supported for directory buckets.
--grant-read (string)
Allows grantee to list the objects in the bucket.
NoteThis functionality is not supported for directory buckets.
--grant-read-acp (string)
Allows grantee to read the bucket ACL.
NoteThis functionality is not supported for directory buckets.
--grant-write (string)
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
NoteThis functionality is not supported for directory buckets.
--grant-write-acp (string)
Allows grantee to write the ACL for the applicable bucket.
NoteThis functionality is not supported for directory buckets.
--object-lock-enabled-for-bucket | --no-object-lock-enabled-for-bucket (boolean)
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
NoteThis functionality is not supported for directory buckets.
--object-ownership (string)
The container element for object ownership for a bucketâs ownership controls.
BucketOwnerPreferred- Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with thebucket-owner-full-controlcanned ACL.
ObjectWriter- The uploading account will own the object if the object is uploaded with thebucket-owner-full-controlcanned ACL.
BucketOwnerEnforced- Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that donât specify an ACL or specify bucket owner full control ACLs (such as the predefinedbucket-owner-full-controlcanned ACL or a custom ACL in XML format that grants the same permissions).By default,
NoteThis functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.ObjectOwnershipis set toBucketOwnerEnforcedand ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide .Possible values:
BucketOwnerPreferredObjectWriterBucketOwnerEnforced
--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override commandâs default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶ NoteTo use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminalâs quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To create a bucket
The following create-bucket example creates a bucket named amzn-s3-demo-bucket:
aws s3api create-bucket \
--bucket amzn-s3-demo-bucket \
--region us-east-1
Output:
{
"Location": "/amzn-s3-demo-bucket"
}
For more information, see Creating a bucket in the Amazon S3 User Guide.
Example 2: To create a bucket with owner enforced
The following create-bucket example creates a bucket named amzn-s3-demo-bucket that uses the bucket owner enforced setting for S3 Object Ownership.
aws s3api create-bucket \
--bucket amzn-s3-demo-bucket \
--region us-east-1 \
--object-ownership BucketOwnerEnforced
Output:
{
"Location": "/amzn-s3-demo-bucket"
}
For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
Example 3: To create a bucket outside of the ``us-east-1`` region
The following create-bucket example creates a bucket named amzn-s3-demo-bucket in the eu-west-1 region. Regions outside of us-east-1 require the appropriate LocationConstraint to be specified in order to create the bucket in the desired region.
aws s3api create-bucket \
--bucket amzn-s3-demo-bucket \
--region eu-west-1 \
--create-bucket-configuration LocationConstraint=eu-west-1
Output:
{
"Location": "http://amzn-s3-demo-bucket.s3.amazonaws.com/"
}
For more information, see Creating a bucket in the Amazon S3 User Guide.
Output¶Location -> (string)
A forward slash followed by the name of the bucket.
BucketArn -> (string)
The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4