Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
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.
If your bucket uses the bucket owner enforced setting for S3 Object
Ownership, ACLs are disabled and no longer affect permissions. You must
use policies to grant access to your bucket and the objects in it.
Requests to set ACLs or update ACLs fail and return the
AccessControlListNotSupported
error code. Requests to read ACLs are
still supported. For more information, see
Controlling object ownership
in the Amazon S3 User Guide.
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 ofx-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
, andx-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use thex-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 Amazon Web Services accounturi
– if you are granting permissions to a predefined groupemailAddress
– if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services General Reference.
Related Resources
Synopsis
- data PutBucketAcl = PutBucketAcl' {
- acl :: Maybe BucketCannedACL
- accessControlPolicy :: Maybe AccessControlPolicy
- checksumAlgorithm :: Maybe ChecksumAlgorithm
- contentMD5 :: Maybe Text
- expectedBucketOwner :: Maybe Text
- grantFullControl :: Maybe Text
- grantRead :: Maybe Text
- grantReadACP :: Maybe Text
- grantWrite :: Maybe Text
- grantWriteACP :: Maybe Text
- bucket :: BucketName
- newPutBucketAcl :: BucketName -> PutBucketAcl
- putBucketAcl_acl :: Lens' PutBucketAcl (Maybe BucketCannedACL)
- putBucketAcl_accessControlPolicy :: Lens' PutBucketAcl (Maybe AccessControlPolicy)
- putBucketAcl_checksumAlgorithm :: Lens' PutBucketAcl (Maybe ChecksumAlgorithm)
- putBucketAcl_contentMD5 :: Lens' PutBucketAcl (Maybe Text)
- putBucketAcl_expectedBucketOwner :: Lens' PutBucketAcl (Maybe Text)
- putBucketAcl_grantFullControl :: Lens' PutBucketAcl (Maybe Text)
- putBucketAcl_grantRead :: Lens' PutBucketAcl (Maybe Text)
- putBucketAcl_grantReadACP :: Lens' PutBucketAcl (Maybe Text)
- putBucketAcl_grantWrite :: Lens' PutBucketAcl (Maybe Text)
- putBucketAcl_grantWriteACP :: Lens' PutBucketAcl (Maybe Text)
- putBucketAcl_bucket :: Lens' PutBucketAcl BucketName
- data PutBucketAclResponse = PutBucketAclResponse' {
- newPutBucketAclResponse :: PutBucketAclResponse
Creating a Request
data PutBucketAcl Source #
See: newPutBucketAcl
smart constructor.
PutBucketAcl' | |
|
Instances
Create a value of PutBucketAcl
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acl:PutBucketAcl'
, putBucketAcl_acl
- The canned ACL to apply to the bucket.
$sel:accessControlPolicy:PutBucketAcl'
, putBucketAcl_accessControlPolicy
- Contains the elements that set the ACL permissions for an object per
grantee.
PutBucketAcl
, putBucketAcl_checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request
. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.
$sel:contentMD5:PutBucketAcl'
, putBucketAcl_contentMD5
- 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.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
$sel:expectedBucketOwner:PutBucketAcl'
, putBucketAcl_expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden
(access denied).
$sel:grantFullControl:PutBucketAcl'
, putBucketAcl_grantFullControl
- Allows grantee the read, write, read ACP, and write ACP permissions on
the bucket.
$sel:grantRead:PutBucketAcl'
, putBucketAcl_grantRead
- Allows grantee to list the objects in the bucket.
$sel:grantReadACP:PutBucketAcl'
, putBucketAcl_grantReadACP
- Allows grantee to read the bucket ACL.
$sel:grantWrite:PutBucketAcl'
, putBucketAcl_grantWrite
- 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.
$sel:grantWriteACP:PutBucketAcl'
, putBucketAcl_grantWriteACP
- Allows grantee to write the ACL for the applicable bucket.
PutBucketAcl
, putBucketAcl_bucket
- The bucket to which to apply the ACL.
Request Lenses
putBucketAcl_acl :: Lens' PutBucketAcl (Maybe BucketCannedACL) Source #
The canned ACL to apply to the bucket.
putBucketAcl_accessControlPolicy :: Lens' PutBucketAcl (Maybe AccessControlPolicy) Source #
Contains the elements that set the ACL permissions for an object per grantee.
putBucketAcl_checksumAlgorithm :: Lens' PutBucketAcl (Maybe ChecksumAlgorithm) Source #
Indicates the algorithm used to create the checksum for the object when
using the SDK. This header will not provide any additional functionality
if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent.
Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request
. For more information, see
Checking object integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.
putBucketAcl_contentMD5 :: Lens' PutBucketAcl (Maybe Text) Source #
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.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
putBucketAcl_expectedBucketOwner :: Lens' PutBucketAcl (Maybe Text) Source #
The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden
(access denied).
putBucketAcl_grantFullControl :: Lens' PutBucketAcl (Maybe Text) Source #
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
putBucketAcl_grantRead :: Lens' PutBucketAcl (Maybe Text) Source #
Allows grantee to list the objects in the bucket.
putBucketAcl_grantReadACP :: Lens' PutBucketAcl (Maybe Text) Source #
Allows grantee to read the bucket ACL.
putBucketAcl_grantWrite :: Lens' PutBucketAcl (Maybe Text) Source #
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.
putBucketAcl_grantWriteACP :: Lens' PutBucketAcl (Maybe Text) Source #
Allows grantee to write the ACL for the applicable bucket.
putBucketAcl_bucket :: Lens' PutBucketAcl BucketName Source #
The bucket to which to apply the ACL.
Destructuring the Response
data PutBucketAclResponse Source #
See: newPutBucketAclResponse
smart constructor.
Instances
Generic PutBucketAclResponse Source # | |
Defined in Amazonka.S3.PutBucketAcl type Rep PutBucketAclResponse :: Type -> Type # from :: PutBucketAclResponse -> Rep PutBucketAclResponse x # to :: Rep PutBucketAclResponse x -> PutBucketAclResponse # | |
Read PutBucketAclResponse Source # | |
Defined in Amazonka.S3.PutBucketAcl | |
Show PutBucketAclResponse Source # | |
Defined in Amazonka.S3.PutBucketAcl showsPrec :: Int -> PutBucketAclResponse -> ShowS # show :: PutBucketAclResponse -> String # showList :: [PutBucketAclResponse] -> ShowS # | |
NFData PutBucketAclResponse Source # | |
Defined in Amazonka.S3.PutBucketAcl rnf :: PutBucketAclResponse -> () # | |
Eq PutBucketAclResponse Source # | |
Defined in Amazonka.S3.PutBucketAcl (==) :: PutBucketAclResponse -> PutBucketAclResponse -> Bool # (/=) :: PutBucketAclResponse -> PutBucketAclResponse -> Bool # | |
type Rep PutBucketAclResponse Source # | |
newPutBucketAclResponse :: PutBucketAclResponse Source #
Create a value of PutBucketAclResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.