Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
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 How to Select a Region for Your Buckets.
If you send your create bucket request to the s3.amazonaws.com 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 Virtual Hosting of Buckets.
When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
-
Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
-
Specify access permissions explicitly using the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
-
id – if the value specified is the canonical user ID of an AWS account
-
uri – if you are granting permissions to a predefined group
-
emailAddress – if the value specified is the email address of an AWS account
NoteUsing email addresses to specify a grantee is only supported in the following AWS Regions:
-
US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
-
For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
-
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
The following operations are related to CreateBucket:
Request Syntax
PUT / HTTP/1.1 Host: Bucket.s3.amazonaws.com x-amz-acl: ACL x-amz-grant-full-control: GrantFullControl x-amz-grant-read: GrantRead x-amz-grant-read-acp: GrantReadACP x-amz-grant-write: GrantWrite x-amz-grant-write-acp: GrantWriteACP x-amz-bucket-object-lock-enabled: ObjectLockEnabledForBucket <?xml version="1.0" encoding="UTF-8"?> <CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <LocationConstraint>string</LocationConstraint> </CreateBucketConfiguration>
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The name of the bucket to create.
Required: Yes
- x-amz-acl
-
The canned ACL to apply to the bucket.
Valid Values: private | public-read | public-read-write | authenticated-read
- x-amz-bucket-object-lock-enabled
-
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
- x-amz-grant-full-control
-
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
- x-amz-grant-read
-
Allows grantee to list the objects in the bucket.
- x-amz-grant-read-acp
-
Allows grantee to read the bucket ACL.
- x-amz-grant-write
-
Allows grantee to create, overwrite, and delete any object in the bucket.
- x-amz-grant-write-acp
-
Allows grantee to write the ACL for the applicable bucket.
Request Body
The request accepts the following data in XML format.
- CreateBucketConfiguration
-
Root level tag for the CreateBucketConfiguration parameters.
Required: Yes
- LocationConstraint
-
Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).
Type: String
Valid Values: af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | 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
Required: No
Response Syntax
HTTP/1.1 200 Location: Location
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- Location
-
Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.
Examples
Sample Request
This request creates a bucket named colorpictures.
PUT / HTTP/1.1 Host: colorpictures.s3.<Region>.amazonaws.com Content-Length: 0 Date: Wed, 01 Mar 2006 12:00:00 GMT Authorization: authorization string
Sample Response
HTTP/1.1 200 OK x-amz-id-2: YgIPIfBiKa2bj0KMg95r/0zo3emzU4dzsD4rcKCHQUAdQkf3ShJTOOpXUueF6QKo x-amz-request-id: 236A8905248E5A01 Date: Wed, 01 Mar 2006 12:00:00 GMT Location: /colorpictures Content-Length: 0 Connection: close Server: AmazonS3
Sample Request: Setting the Region of a bucket
The following request sets the Region for the bucket to Europe.
PUT / HTTP/1.1 Host: bucketName.s3.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT Authorization: authorization string Content-Type: text/plain Content-Length: 124 <CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <LocationConstraint>Europe</LocationConstraint> </CreateBucketConfiguration >
Sample Request: Creating a bucket and configuring access permission using a canned ACL
This request creates a bucket named colorpictures and sets the ACL to private.
PUT / HTTP/1.1 Host: colorpictures.s3.<Region>.amazonaws.com Content-Length: 0 x-amz-acl: private Date: Wed, 01 Mar 2006 12:00:00 GMT Authorization: authorization string
Sample Response
HTTP/1.1 200 OK x-amz-id-2: YgIPIfBiKa2bj0KMg95r/0zo3emzU4dzsD4rcKCHQUAdQkf3ShJTOOpXUueF6QKo x-amz-request-id: 236A8905248E5A01 Date: Wed, 01 Mar 2006 12:00:00 GMT Location: /colorpictures Content-Length: 0 Connection: close Server: AmazonS3
Sample Request: Creating a bucket and configuring access permissions explicitly
This request creates a bucket named colorpictures and grants WRITE permission to the AWS account identified by an email address.
PUT HTTP/1.1 Host: colorpictures.s3.<Region>.amazonaws.com x-amz-date: Sat, 07 Apr 2012 00:54:40 GMT Authorization: authorization string x-amz-grant-write: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com"
Sample Response
HTTP/1.1 200 OK