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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

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

The following operations are related to GetBucketPolicyStatus:

Creating a Request

data GetBucketPolicyStatus Source #

See: newGetBucketPolicyStatus smart constructor.

Constructors

GetBucketPolicyStatus'
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 policy status you want to retrieve.

Instances

Instances details

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

newGetBucketPolicyStatus Source #

Arguments

:: BucketName	`GetBucketPolicyStatus`
-> GetBucketPolicyStatus

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

GetBucketPolicyStatus, getBucketPolicyStatus_bucket - The name of the Amazon S3 bucket whose policy status you want to retrieve.

Request Lenses

getBucketPolicyStatus_expectedBucketOwner :: Lens' GetBucketPolicyStatus (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).

getBucketPolicyStatus_bucket :: Lens' GetBucketPolicyStatus BucketName Source #

The name of the Amazon S3 bucket whose policy status you want to retrieve.

Destructuring the Response

data GetBucketPolicyStatusResponse Source #

See: newGetBucketPolicyStatusResponse smart constructor.

Constructors

GetBucketPolicyStatusResponse'
Fields policyStatus :: Maybe PolicyStatus The policy status for the specified bucket. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetBucketPolicyStatusResponse Source #

Arguments

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

Create a value of GetBucketPolicyStatusResponse 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:policyStatus:GetBucketPolicyStatusResponse', getBucketPolicyStatusResponse_policyStatus - The policy status for the specified bucket.

$sel:httpStatus:GetBucketPolicyStatusResponse', getBucketPolicyStatusResponse_httpStatus - The response's http status code.

Response Lenses

getBucketPolicyStatusResponse_policyStatus :: Lens' GetBucketPolicyStatusResponse (Maybe PolicyStatus) Source #

The policy status for the specified bucket.

getBucketPolicyStatusResponse_httpStatus :: Lens' GetBucketPolicyStatusResponse Int Source #

The response's http status code.