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

Amazonka.S3.GetBucketAcl

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

Related Resources

ListObjects

Creating a Request

data GetBucketAcl Source #

See: newGetBucketAcl smart constructor.

Constructors

GetBucketAcl'
Fields expectedBucketOwner :: Maybe Text 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). bucket :: BucketName Specifies the S3 bucket whose ACL is being requested.

Instances

Instances details

ToHeaders GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods toHeaders :: GetBucketAcl -> [Header] #
ToPath GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods toPath :: GetBucketAcl -> ByteString #
ToQuery GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods toQuery :: GetBucketAcl -> QueryString #
AWSRequest GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Associated Types type AWSResponse GetBucketAcl # Methods request :: (Service -> Service) -> GetBucketAcl -> Request GetBucketAcl # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBucketAcl -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketAcl))) #
Generic GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Associated Types type Rep GetBucketAcl :: Type -> Type # Methods from :: GetBucketAcl -> Rep GetBucketAcl x # to :: Rep GetBucketAcl x -> GetBucketAcl #
Read GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods readsPrec :: Int -> ReadS GetBucketAcl # readList :: ReadS [GetBucketAcl] # readPrec :: ReadPrec GetBucketAcl # readListPrec :: ReadPrec [GetBucketAcl] #
Show GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods showsPrec :: Int -> GetBucketAcl -> ShowS # show :: GetBucketAcl -> String # showList :: [GetBucketAcl] -> ShowS #
NFData GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods rnf :: GetBucketAcl -> () #
Eq GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods (==) :: GetBucketAcl -> GetBucketAcl -> Bool # (/=) :: GetBucketAcl -> GetBucketAcl -> Bool #
Hashable GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods hashWithSalt :: Int -> GetBucketAcl -> Int # hash :: GetBucketAcl -> Int #
type AWSResponse GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl type AWSResponse GetBucketAcl = GetBucketAclResponse
type Rep GetBucketAcl Source #
Instance details Defined in Amazonka.S3.GetBucketAcl type Rep GetBucketAcl = D1 ('MetaData "GetBucketAcl" "Amazonka.S3.GetBucketAcl" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetBucketAcl'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName)))

newGetBucketAcl Source #

Arguments

:: BucketName	`GetBucketAcl`
-> GetBucketAcl

Create a value of GetBucketAcl 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:expectedBucketOwner:GetBucketAcl', getBucketAcl_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).

GetBucketAcl, getBucketAcl_bucket - Specifies the S3 bucket whose ACL is being requested.

Request Lenses

getBucketAcl_expectedBucketOwner :: Lens' GetBucketAcl (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).

getBucketAcl_bucket :: Lens' GetBucketAcl BucketName Source #

Specifies the S3 bucket whose ACL is being requested.

Destructuring the Response

data GetBucketAclResponse Source #

See: newGetBucketAclResponse smart constructor.

Constructors

GetBucketAclResponse'
Fields grants :: Maybe [Grant] A list of grants. owner :: Maybe Owner Container for the bucket owner's display name and ID. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetBucketAclResponse Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Associated Types type Rep GetBucketAclResponse :: Type -> Type # Methods from :: GetBucketAclResponse -> Rep GetBucketAclResponse x # to :: Rep GetBucketAclResponse x -> GetBucketAclResponse #
Read GetBucketAclResponse Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods readsPrec :: Int -> ReadS GetBucketAclResponse # readList :: ReadS [GetBucketAclResponse] # readPrec :: ReadPrec GetBucketAclResponse # readListPrec :: ReadPrec [GetBucketAclResponse] #
Show GetBucketAclResponse Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods showsPrec :: Int -> GetBucketAclResponse -> ShowS # show :: GetBucketAclResponse -> String # showList :: [GetBucketAclResponse] -> ShowS #
NFData GetBucketAclResponse Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods rnf :: GetBucketAclResponse -> () #
Eq GetBucketAclResponse Source #
Instance details Defined in Amazonka.S3.GetBucketAcl Methods (==) :: GetBucketAclResponse -> GetBucketAclResponse -> Bool # (/=) :: GetBucketAclResponse -> GetBucketAclResponse -> Bool #
type Rep GetBucketAclResponse Source #
Instance details Defined in Amazonka.S3.GetBucketAcl type Rep GetBucketAclResponse = D1 ('MetaData "GetBucketAclResponse" "Amazonka.S3.GetBucketAcl" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetBucketAclResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Grant])) :: (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Owner)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBucketAclResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetBucketAclResponse'`
-> GetBucketAclResponse

Create a value of GetBucketAclResponse 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:

GetBucketAclResponse, getBucketAclResponse_grants - A list of grants.

GetBucketAclResponse, getBucketAclResponse_owner - Container for the bucket owner's display name and ID.

$sel:httpStatus:GetBucketAclResponse', getBucketAclResponse_httpStatus - The response's http status code.

Response Lenses

getBucketAclResponse_grants :: Lens' GetBucketAclResponse (Maybe [Grant]) Source #

A list of grants.

getBucketAclResponse_owner :: Lens' GetBucketAclResponse (Maybe Owner) Source #

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

getBucketAclResponse_httpStatus :: Lens' GetBucketAclResponse Int Source #

The response's http status code.