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.GetPublicAccessBlock

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

The following operations are related to GetPublicAccessBlock:

Creating a Request

data GetPublicAccessBlock Source #

See: newGetPublicAccessBlock smart constructor.

Constructors

GetPublicAccessBlock'
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 The name of the Amazon S3 bucket whose `PublicAccessBlock` configuration you want to retrieve.

Instances

Instances details

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

newGetPublicAccessBlock Source #

Arguments

:: BucketName	`GetPublicAccessBlock`
-> GetPublicAccessBlock

Create a value of GetPublicAccessBlock 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:GetPublicAccessBlock', getPublicAccessBlock_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).

GetPublicAccessBlock, getPublicAccessBlock_bucket - The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

Request Lenses

getPublicAccessBlock_expectedBucketOwner :: Lens' GetPublicAccessBlock (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).

getPublicAccessBlock_bucket :: Lens' GetPublicAccessBlock BucketName Source #

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

Destructuring the Response

data GetPublicAccessBlockResponse Source #

See: newGetPublicAccessBlockResponse smart constructor.

Constructors

GetPublicAccessBlockResponse'
Fields publicAccessBlockConfiguration :: Maybe PublicAccessBlockConfiguration The `PublicAccessBlock` configuration currently in effect for this Amazon S3 bucket. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetPublicAccessBlockResponse Source #

Arguments

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

Create a value of GetPublicAccessBlockResponse 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:publicAccessBlockConfiguration:GetPublicAccessBlockResponse', getPublicAccessBlockResponse_publicAccessBlockConfiguration - The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

$sel:httpStatus:GetPublicAccessBlockResponse', getPublicAccessBlockResponse_httpStatus - The response's http status code.

Response Lenses

getPublicAccessBlockResponse_publicAccessBlockConfiguration :: Lens' GetPublicAccessBlockResponse (Maybe PublicAccessBlockConfiguration) Source #

The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

getPublicAccessBlockResponse_httpStatus :: Lens' GetPublicAccessBlockResponse Int Source #

The response's http status code.