Sets the permissions on an existing bucket using access control lists
(ACL). For more information, see Using ACLs.
To set the ACL of a bucket, you must have WRITE_ACP permission.
s3_put_bucket_acl(ACL, AccessControlPolicy, Bucket, ContentMD5,
GrantFullControl, GrantRead, GrantReadACP, GrantWrite, GrantWriteACP)The canned ACL to apply to the bucket.
Contains the elements that set the ACL permissions for an object per grantee.
[required] The bucket to which to apply the ACL.
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
Allows grantee to list the objects in the bucket.
Allows grantee to read the bucket ACL.
Allows grantee to create, overwrite, and delete any object in the bucket.
Allows grantee to write the ACL for the applicable bucket.
svc$put_bucket_acl(
ACL = "private"|"public-read"|"public-read-write"|"authenticated-read",
AccessControlPolicy = list(
Grants = list(
list(
Grantee = list(
DisplayName = "string",
EmailAddress = "string",
ID = "string",
Type = "CanonicalUser"|"AmazonCustomerByEmail"|"Group",
URI = "string"
),
Permission = "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"
)
),
Owner = list(
DisplayName = "string",
ID = "string"
)
),
Bucket = "string",
ContentMD5 = "string",
GrantFullControl = "string",
GrantRead = "string",
GrantReadACP = "string",
GrantWrite = "string",
GrantWriteACP = "string"
)
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
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.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with 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. Specify
the canned ACL name as the value of x-amz-acl. If you use this
header, you cannot use other access control-specific headers in your
request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read,
x-amz-grant-read-acp, x-amz-grant-write-acp, and
x-amz-grant-full-control headers. When using these headers, you
specify explicit access permissions and grantees (AWS accounts or
Amazon S3 groups) who will receive the permission. If you use these
ACL-specific headers, you cannot use the x-amz-acl header to set a
canned ACL. These parameters map to the set of permissions that
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
Using 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<U+00C3><U+00A3>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-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", id="111122223333", id="555566667777"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
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 URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
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.
Using 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<U+00C3><U+00A3>o Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
Related Resources
CreateBucket
DeleteBucket
GetObjectAcl
# NOT RUN {
# The following example replaces existing ACL on a bucket. The ACL grants
# the bucket owner (specified using the owner ID) and write permission to
# the LogDelivery group. Because this is a replace operation, you must
# specify all the grants in your request. To incrementally add or remove
# ACL grants, you might use the console.
svc$put_bucket_acl(
Bucket = "examplebucket",
GrantFullControl = "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484",
GrantWrite = "uri=http://acs.amazonaws.com/groups/s3/LogDelivery"
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab