{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.S3.GetPublicAccessBlock
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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
-- <https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html 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
-- <https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status The Meaning of \"Public\">.
--
-- The following operations are related to @GetPublicAccessBlock@:
--
-- -   <https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html Using Amazon S3 Block Public Access>
--
-- -   <https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html PutPublicAccessBlock>
--
-- -   <https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html GetPublicAccessBlock>
--
-- -   <https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html DeletePublicAccessBlock>
module Amazonka.S3.GetPublicAccessBlock
  ( -- * Creating a Request
    GetPublicAccessBlock (..),
    newGetPublicAccessBlock,

    -- * Request Lenses
    getPublicAccessBlock_expectedBucketOwner,
    getPublicAccessBlock_bucket,

    -- * Destructuring the Response
    GetPublicAccessBlockResponse (..),
    newGetPublicAccessBlockResponse,

    -- * Response Lenses
    getPublicAccessBlockResponse_publicAccessBlockConfiguration,
    getPublicAccessBlockResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.S3.Types

-- | /See:/ 'newGetPublicAccessBlock' smart constructor.
data GetPublicAccessBlock = GetPublicAccessBlock'
  { -- | 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 -> Maybe Text
expectedBucketOwner :: Prelude.Maybe Prelude.Text,
    -- | The name of the Amazon S3 bucket whose @PublicAccessBlock@ configuration
    -- you want to retrieve.
    GetPublicAccessBlock -> BucketName
bucket :: BucketName
  }
  deriving (GetPublicAccessBlock -> GetPublicAccessBlock -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetPublicAccessBlock -> GetPublicAccessBlock -> Bool
$c/= :: GetPublicAccessBlock -> GetPublicAccessBlock -> Bool
== :: GetPublicAccessBlock -> GetPublicAccessBlock -> Bool
$c== :: GetPublicAccessBlock -> GetPublicAccessBlock -> Bool
Prelude.Eq, ReadPrec [GetPublicAccessBlock]
ReadPrec GetPublicAccessBlock
Int -> ReadS GetPublicAccessBlock
ReadS [GetPublicAccessBlock]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetPublicAccessBlock]
$creadListPrec :: ReadPrec [GetPublicAccessBlock]
readPrec :: ReadPrec GetPublicAccessBlock
$creadPrec :: ReadPrec GetPublicAccessBlock
readList :: ReadS [GetPublicAccessBlock]
$creadList :: ReadS [GetPublicAccessBlock]
readsPrec :: Int -> ReadS GetPublicAccessBlock
$creadsPrec :: Int -> ReadS GetPublicAccessBlock
Prelude.Read, Int -> GetPublicAccessBlock -> ShowS
[GetPublicAccessBlock] -> ShowS
GetPublicAccessBlock -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetPublicAccessBlock] -> ShowS
$cshowList :: [GetPublicAccessBlock] -> ShowS
show :: GetPublicAccessBlock -> String
$cshow :: GetPublicAccessBlock -> String
showsPrec :: Int -> GetPublicAccessBlock -> ShowS
$cshowsPrec :: Int -> GetPublicAccessBlock -> ShowS
Prelude.Show, forall x. Rep GetPublicAccessBlock x -> GetPublicAccessBlock
forall x. GetPublicAccessBlock -> Rep GetPublicAccessBlock x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetPublicAccessBlock x -> GetPublicAccessBlock
$cfrom :: forall x. GetPublicAccessBlock -> Rep GetPublicAccessBlock x
Prelude.Generic)

-- |
-- Create a value of 'GetPublicAccessBlock' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'expectedBucketOwner', '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).
--
-- 'bucket', 'getPublicAccessBlock_bucket' - The name of the Amazon S3 bucket whose @PublicAccessBlock@ configuration
-- you want to retrieve.
newGetPublicAccessBlock ::
  -- | 'bucket'
  BucketName ->
  GetPublicAccessBlock
newGetPublicAccessBlock :: BucketName -> GetPublicAccessBlock
newGetPublicAccessBlock BucketName
pBucket_ =
  GetPublicAccessBlock'
    { $sel:expectedBucketOwner:GetPublicAccessBlock' :: Maybe Text
expectedBucketOwner =
        forall a. Maybe a
Prelude.Nothing,
      $sel:bucket:GetPublicAccessBlock' :: BucketName
bucket = BucketName
pBucket_
    }

-- | 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_expectedBucketOwner :: Lens.Lens' GetPublicAccessBlock (Prelude.Maybe Prelude.Text)
getPublicAccessBlock_expectedBucketOwner :: Lens' GetPublicAccessBlock (Maybe Text)
getPublicAccessBlock_expectedBucketOwner = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPublicAccessBlock' {Maybe Text
expectedBucketOwner :: Maybe Text
$sel:expectedBucketOwner:GetPublicAccessBlock' :: GetPublicAccessBlock -> Maybe Text
expectedBucketOwner} -> Maybe Text
expectedBucketOwner) (\s :: GetPublicAccessBlock
s@GetPublicAccessBlock' {} Maybe Text
a -> GetPublicAccessBlock
s {$sel:expectedBucketOwner:GetPublicAccessBlock' :: Maybe Text
expectedBucketOwner = Maybe Text
a} :: GetPublicAccessBlock)

-- | The name of the Amazon S3 bucket whose @PublicAccessBlock@ configuration
-- you want to retrieve.
getPublicAccessBlock_bucket :: Lens.Lens' GetPublicAccessBlock BucketName
getPublicAccessBlock_bucket :: Lens' GetPublicAccessBlock BucketName
getPublicAccessBlock_bucket = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPublicAccessBlock' {BucketName
bucket :: BucketName
$sel:bucket:GetPublicAccessBlock' :: GetPublicAccessBlock -> BucketName
bucket} -> BucketName
bucket) (\s :: GetPublicAccessBlock
s@GetPublicAccessBlock' {} BucketName
a -> GetPublicAccessBlock
s {$sel:bucket:GetPublicAccessBlock' :: BucketName
bucket = BucketName
a} :: GetPublicAccessBlock)

instance Core.AWSRequest GetPublicAccessBlock where
  type
    AWSResponse GetPublicAccessBlock =
      GetPublicAccessBlockResponse
  request :: (Service -> Service)
-> GetPublicAccessBlock -> Request GetPublicAccessBlock
request Service -> Service
overrides =
    forall a. Request a -> Request a
Request.s3vhost
      forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy GetPublicAccessBlock
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetPublicAccessBlock)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXML
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe PublicAccessBlockConfiguration
-> Int -> GetPublicAccessBlockResponse
GetPublicAccessBlockResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (forall a. FromXML a => [Node] -> Either String a
Data.parseXML [Node]
x)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable GetPublicAccessBlock where
  hashWithSalt :: Int -> GetPublicAccessBlock -> Int
hashWithSalt Int
_salt GetPublicAccessBlock' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetPublicAccessBlock' :: GetPublicAccessBlock -> BucketName
$sel:expectedBucketOwner:GetPublicAccessBlock' :: GetPublicAccessBlock -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
expectedBucketOwner
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` BucketName
bucket

instance Prelude.NFData GetPublicAccessBlock where
  rnf :: GetPublicAccessBlock -> ()
rnf GetPublicAccessBlock' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetPublicAccessBlock' :: GetPublicAccessBlock -> BucketName
$sel:expectedBucketOwner:GetPublicAccessBlock' :: GetPublicAccessBlock -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
expectedBucketOwner
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf BucketName
bucket

instance Data.ToHeaders GetPublicAccessBlock where
  toHeaders :: GetPublicAccessBlock -> ResponseHeaders
toHeaders GetPublicAccessBlock' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetPublicAccessBlock' :: GetPublicAccessBlock -> BucketName
$sel:expectedBucketOwner:GetPublicAccessBlock' :: GetPublicAccessBlock -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ HeaderName
"x-amz-expected-bucket-owner"
          forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# Maybe Text
expectedBucketOwner
      ]

instance Data.ToPath GetPublicAccessBlock where
  toPath :: GetPublicAccessBlock -> ByteString
toPath GetPublicAccessBlock' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetPublicAccessBlock' :: GetPublicAccessBlock -> BucketName
$sel:expectedBucketOwner:GetPublicAccessBlock' :: GetPublicAccessBlock -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat [ByteString
"/", forall a. ToByteString a => a -> ByteString
Data.toBS BucketName
bucket]

instance Data.ToQuery GetPublicAccessBlock where
  toQuery :: GetPublicAccessBlock -> QueryString
toQuery =
    forall a b. a -> b -> a
Prelude.const
      (forall a. Monoid a => [a] -> a
Prelude.mconcat [QueryString
"publicAccessBlock"])

-- | /See:/ 'newGetPublicAccessBlockResponse' smart constructor.
data GetPublicAccessBlockResponse = GetPublicAccessBlockResponse'
  { -- | The @PublicAccessBlock@ configuration currently in effect for this
    -- Amazon S3 bucket.
    GetPublicAccessBlockResponse
-> Maybe PublicAccessBlockConfiguration
publicAccessBlockConfiguration :: Prelude.Maybe PublicAccessBlockConfiguration,
    -- | The response's http status code.
    GetPublicAccessBlockResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetPublicAccessBlockResponse
-> GetPublicAccessBlockResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetPublicAccessBlockResponse
-> GetPublicAccessBlockResponse -> Bool
$c/= :: GetPublicAccessBlockResponse
-> GetPublicAccessBlockResponse -> Bool
== :: GetPublicAccessBlockResponse
-> GetPublicAccessBlockResponse -> Bool
$c== :: GetPublicAccessBlockResponse
-> GetPublicAccessBlockResponse -> Bool
Prelude.Eq, ReadPrec [GetPublicAccessBlockResponse]
ReadPrec GetPublicAccessBlockResponse
Int -> ReadS GetPublicAccessBlockResponse
ReadS [GetPublicAccessBlockResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetPublicAccessBlockResponse]
$creadListPrec :: ReadPrec [GetPublicAccessBlockResponse]
readPrec :: ReadPrec GetPublicAccessBlockResponse
$creadPrec :: ReadPrec GetPublicAccessBlockResponse
readList :: ReadS [GetPublicAccessBlockResponse]
$creadList :: ReadS [GetPublicAccessBlockResponse]
readsPrec :: Int -> ReadS GetPublicAccessBlockResponse
$creadsPrec :: Int -> ReadS GetPublicAccessBlockResponse
Prelude.Read, Int -> GetPublicAccessBlockResponse -> ShowS
[GetPublicAccessBlockResponse] -> ShowS
GetPublicAccessBlockResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetPublicAccessBlockResponse] -> ShowS
$cshowList :: [GetPublicAccessBlockResponse] -> ShowS
show :: GetPublicAccessBlockResponse -> String
$cshow :: GetPublicAccessBlockResponse -> String
showsPrec :: Int -> GetPublicAccessBlockResponse -> ShowS
$cshowsPrec :: Int -> GetPublicAccessBlockResponse -> ShowS
Prelude.Show, forall x.
Rep GetPublicAccessBlockResponse x -> GetPublicAccessBlockResponse
forall x.
GetPublicAccessBlockResponse -> Rep GetPublicAccessBlockResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetPublicAccessBlockResponse x -> GetPublicAccessBlockResponse
$cfrom :: forall x.
GetPublicAccessBlockResponse -> Rep GetPublicAccessBlockResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetPublicAccessBlockResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'publicAccessBlockConfiguration', 'getPublicAccessBlockResponse_publicAccessBlockConfiguration' - The @PublicAccessBlock@ configuration currently in effect for this
-- Amazon S3 bucket.
--
-- 'httpStatus', 'getPublicAccessBlockResponse_httpStatus' - The response's http status code.
newGetPublicAccessBlockResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetPublicAccessBlockResponse
newGetPublicAccessBlockResponse :: Int -> GetPublicAccessBlockResponse
newGetPublicAccessBlockResponse Int
pHttpStatus_ =
  GetPublicAccessBlockResponse'
    { $sel:publicAccessBlockConfiguration:GetPublicAccessBlockResponse' :: Maybe PublicAccessBlockConfiguration
publicAccessBlockConfiguration =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetPublicAccessBlockResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The @PublicAccessBlock@ configuration currently in effect for this
-- Amazon S3 bucket.
getPublicAccessBlockResponse_publicAccessBlockConfiguration :: Lens.Lens' GetPublicAccessBlockResponse (Prelude.Maybe PublicAccessBlockConfiguration)
getPublicAccessBlockResponse_publicAccessBlockConfiguration :: Lens'
  GetPublicAccessBlockResponse (Maybe PublicAccessBlockConfiguration)
getPublicAccessBlockResponse_publicAccessBlockConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPublicAccessBlockResponse' {Maybe PublicAccessBlockConfiguration
publicAccessBlockConfiguration :: Maybe PublicAccessBlockConfiguration
$sel:publicAccessBlockConfiguration:GetPublicAccessBlockResponse' :: GetPublicAccessBlockResponse
-> Maybe PublicAccessBlockConfiguration
publicAccessBlockConfiguration} -> Maybe PublicAccessBlockConfiguration
publicAccessBlockConfiguration) (\s :: GetPublicAccessBlockResponse
s@GetPublicAccessBlockResponse' {} Maybe PublicAccessBlockConfiguration
a -> GetPublicAccessBlockResponse
s {$sel:publicAccessBlockConfiguration:GetPublicAccessBlockResponse' :: Maybe PublicAccessBlockConfiguration
publicAccessBlockConfiguration = Maybe PublicAccessBlockConfiguration
a} :: GetPublicAccessBlockResponse)

-- | The response's http status code.
getPublicAccessBlockResponse_httpStatus :: Lens.Lens' GetPublicAccessBlockResponse Prelude.Int
getPublicAccessBlockResponse_httpStatus :: Lens' GetPublicAccessBlockResponse Int
getPublicAccessBlockResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetPublicAccessBlockResponse' {Int
httpStatus :: Int
$sel:httpStatus:GetPublicAccessBlockResponse' :: GetPublicAccessBlockResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: GetPublicAccessBlockResponse
s@GetPublicAccessBlockResponse' {} Int
a -> GetPublicAccessBlockResponse
s {$sel:httpStatus:GetPublicAccessBlockResponse' :: Int
httpStatus = Int
a} :: GetPublicAccessBlockResponse)

instance Prelude.NFData GetPublicAccessBlockResponse where
  rnf :: GetPublicAccessBlockResponse -> ()
rnf GetPublicAccessBlockResponse' {Int
Maybe PublicAccessBlockConfiguration
httpStatus :: Int
publicAccessBlockConfiguration :: Maybe PublicAccessBlockConfiguration
$sel:httpStatus:GetPublicAccessBlockResponse' :: GetPublicAccessBlockResponse -> Int
$sel:publicAccessBlockConfiguration:GetPublicAccessBlockResponse' :: GetPublicAccessBlockResponse
-> Maybe PublicAccessBlockConfiguration
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe PublicAccessBlockConfiguration
publicAccessBlockConfiguration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus