Menu
Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

PUT Bucket acl

Description

This implementation of the PUT operation uses the acl subresource to set the permissions on an existing bucket using access control lists (ACL). For more information, go to Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

  • Specify the ACL in the request body

  • Specify permissions using request headers

Note

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

Requests

Syntax

The following request shows the syntax for sending the ACL in the request body. If you want to use headers to specify the permissions for the bucket, you cannot send the ACL in the request body. Instead, see Request Headers section for a list of headers you can use.

PUT /?acl HTTP/1.1
Host: BucketName.s3.amazonaws.com
Date: date
Authorization: authorization string (see Authenticating Requests (AWS Signature Version
		4))

<AccessControlPolicy>
  <Owner>
    <ID>ID</ID>
    <DisplayName>EmailAddress</DisplayName>
  </Owner>
  <AccessControlList>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
        <ID>ID</ID>
        <DisplayName>EmailAddress</DisplayName>
      </Grantee>
      <Permission>Permission</Permission>
    </Grant>
    ...
  </AccessControlList>
</AccessControlPolicy> 

Request Parameters

This implementation of the operation does not use request parameters.

Request Headers

You can use the following request headers in addition to the Common Request Headers.

These headers enable you to set access permissions using one of the following methods:

  • Specify a canned ACL, or

  • Specify the permission for each grantee explicitly

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. To grant access permissions by specifying canned ACLs, you use the following header and specify the canned ACL name as its value. If you use this header, you cannot use other access control specific headers in your request.

Name Description Required
x-amz-acl

Sets the ACL of the bucket using the specified canned ACL. For more information, go to Canned ACL in the Amazon Simple Storage Service Developer Guide.

Type: String

Valid Values: private | public-read | public-read-write | authenticated-read

Default: private

No

If you need to grant individualized access permissions on a bucket, you can use the following "x-amz-grant-permission" headers. When using these headers you specify explicit access permissions and grantees (AWS accounts or a Amazon S3 groups) who will receive the permission. If you use these ACL specific headers, you cannot use x-amz-acl header to set a canned ACL.

Note

Each of the following request headers maps to specific permissions Amazon S3 supports in an ACL. For more information go to Access Control List (ACL) Overview.

Name Description Required
x-amz-grant-read

Allows the specified grantee(s) to list the objects in the bucket.

Type: String

Default: None

Constraints: None

No
x-amz-grant-write

Allows the specified grantee(s) to create, overwrite, and delete any object in the bucket.

Type: String

Default: None

Constraints: None

No
x-amz-grant-read-acp

Allows the specified grantee(s) to read the bucket ACL.

Type: String

Default: None

Constraints: None

No
x-amz-grant-write-acp

Allows the specified grantee(s) to write the ACL for the applicable bucket.

Type: String

Default: None

Constraints: None

No
x-amz-grant-full-control

Allows the specified grantee(s) the READ, WRITE, READ_ACP, and WRITE_ACP permissions on the bucket.

Type: String

Default: None

Constraints: None

No

For each of these headers, the value is a comma-separated list of one or more grantees. You specify each grantee as a type=value pair, where the type can be one of the following:

  • emailAddress — if value specified is the email address of an AWS account

  • id — if value specified is the canonical User ID of an AWS account

  • uri — if granting permission to a predefined Amazon S3 group.

For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.

x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com"

For more information, go to Access Control List (ACL) Overview. For more information about bucket logging, go to Server Access Logging.

Request Elements

If you decide to use the request body to specify an ACL, you must use the following elements.

Note

If you request the request body, you cannot use the request headers to set an ACL.

Name Description Required
AccessControlList

Container for Grant, Grantee, and Permission

Type: Container

Ancestors: AccessControlPolicy

No
AccessControlPolicy

Contains the elements that set the ACL permissions for an object per grantee.

Type: String

Ancestors: None

No
DisplayName

Screen name of the bucket owner.

Type: String

Ancestors: AccessControlPolicy.Owner

No
Grant

Container for the grantee and his or her permissions.

Type: Container

Ancestors: AccessControlPolicy.AccessControlList

No
Grantee

The subject whose permissions are being set. For more information, see Grantee Values.

Type: String

Ancestors: AccessControlPolicy.AccessControlList.Grant

No
ID

ID of the bucket owner, or the ID of the grantee.

Type: String

Ancestors: AccessControlPolicy.Owner | AccessControlPolicy.AccessControlList.Grant

No
Owner

Container for the bucket owner's display name and ID.

Type: Container

Ancestors: AccessControlPolicy

No
Permission

Specifies the permission given to the grantee.

Type: String

Valid Values: FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP

Ancestors: AccessControlPolicy.AccessControlList.Grant

No

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

  • By the person's ID:

    <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID>ID</ID><DisplayName>GranteesEmail</DisplayName>
    </Grantee>

    DisplayName is optional and ignored in the request.

  • By Email address:

    <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress>Grantees@email.com</EmailAddress>lt;/Grantee>

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

  • By URI:

    <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI>http://acs.amazonaws.com/groups/global/AuthenticatedUsers</URI></Grantee>

Responses

Response Headers

The operation returns response header that are common to most responses. For more information, see Common Response Headers.

Response Elements

This operation does not return response elements.

Special Errors

This operation does not return special errors. For general information about Amazon S3 errors and a list of error codes, see Error Responses.

Examples

Sample Request: Access permissions specified in the body

The following request grants access permission to the existing examplebucket bucket. The request specifies the ACL in the body. In addition to granting full control to the bucket owner, the XML specifies the following grants.

  • Grant AllUsers group READ permission on the bucket.

  • Grant the LogDelivery group WRITE permission on the bucket.

  • Grant an AWS account, identified by email address, WRITE_ACP permission.

  • Grant an AWS account, identified by canonical user ID, READ_ACP permission.

PUT ?acl HTTP/1.1
Host: examplebucket.s3.amazonaws.com
Content-Length: 1660
x-amz-date: Thu, 12 Apr 2012 20:04:21 GMT
Authorization: authorization string

<AccessControlPolicy xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Owner>
    <ID>852b113e7a2f25102679df27bb0ae12b3f85be6BucketOwnerCanonicalUserID</ID>
    <DisplayName>OwnerDisplayName</DisplayName>
  </Owner>
  <AccessControlList>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
        <ID>852b113e7a2f25102679df27bb0ae12b3f85be6BucketOwnerCanonicalUserID</ID>
        <DisplayName>OwnerDisplayName</DisplayName>
      </Grantee>
      <Permission>FULL_CONTROL</Permission>
    </Grant>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
        <URI xmlns="">http://acs.amazonaws.com/groups/global/AllUsers</URI>
      </Grantee>
      <Permission xmlns="">READ</Permission>
    </Grant>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
        <URI xmlns="">http://acs.amazonaws.com/groups/s3/LogDelivery</URI>
      </Grantee>
      <Permission xmlns="">WRITE</Permission>
    </Grant>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail">
        <EmailAddress xmlns="">xyz@amazon.com</EmailAddress>
      </Grantee>
      <Permission xmlns="">WRITE_ACP</Permission>
    </Grant>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
        <ID xmlns="">f30716ab7115dcb44a5ef76e9d74b8e20567f63TestAccountCanonicalUserID</ID>
      </Grantee>
      <Permission xmlns="">READ_ACP</Permission>
    </Grant>
  </AccessControlList>
</AccessControlPolicy>

Sample Response

HTTP/1.1 200 OK
x-amz-id-2: NxqO3PNiMHXXGwjgv15LLgUoAmPVmG0xtZw2sxePXLhpIvcyouXDrcQUaWWXcOK0
x-amz-request-id: C651BC9B4E1BD401
Date: Thu, 12 Apr 2012 20:04:28 GMT
Content-Length: 0
Server: AmazonS3

Sample Request: Access permissions specified using headers

The following request uses ACL-specific request headers to grant the following permissions:

  • Write permission to the Amazon S3 LogDelivery group and an AWS account identified by the email xyz@amazon.com.

  • Read permission to the Amazon S3 AllUsers group

PUT ?acl HTTP/1.1
Host: examplebucket.s3.amazonaws.com
x-amz-date: Sun, 29 Apr 2012 22:00:57 GMT
x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", emailAddress="xyz@amazon.com"
x-amz-grant-read: uri="http://acs.amazonaws.com/groups/global/AllUsers"
Accept: */*
Authorization: authorization string

Sample Response

HTTP/1.1 200 OK
x-amz-id-2: 0w9iImt23VF9s6QofOTDzelF7mrryz7d04Mw23FQCi4O205Zw28Zn+d340/RytoQ
x-amz-request-id: A6A8F01A38EC7138
Date: Sun, 29 Apr 2012 22:01:10 GMT
Content-Length: 0
Server: AmazonS3