{-# 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.GetBucketTagging
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns the tag set associated with the bucket.
--
-- To use this operation, you must have permission to perform the
-- @s3:GetBucketTagging@ action. By default, the bucket owner has this
-- permission and can grant this permission to others.
--
-- @GetBucketTagging@ has the following special error:
--
-- -   Error code: @NoSuchTagSet@
--
--     -   Description: There is no tag set associated with the bucket.
--
-- The following operations are related to @GetBucketTagging@:
--
-- -   <https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html PutBucketTagging>
--
-- -   <https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html DeleteBucketTagging>
module Amazonka.S3.GetBucketTagging
  ( -- * Creating a Request
    GetBucketTagging (..),
    newGetBucketTagging,

    -- * Request Lenses
    getBucketTagging_expectedBucketOwner,
    getBucketTagging_bucket,

    -- * Destructuring the Response
    GetBucketTaggingResponse (..),
    newGetBucketTaggingResponse,

    -- * Response Lenses
    getBucketTaggingResponse_httpStatus,
    getBucketTaggingResponse_tagSet,
  )
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:/ 'newGetBucketTagging' smart constructor.
data GetBucketTagging = GetBucketTagging'
  { -- | 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).
    GetBucketTagging -> Maybe Text
expectedBucketOwner :: Prelude.Maybe Prelude.Text,
    -- | The name of the bucket for which to get the tagging information.
    GetBucketTagging -> BucketName
bucket :: BucketName
  }
  deriving (GetBucketTagging -> GetBucketTagging -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetBucketTagging -> GetBucketTagging -> Bool
$c/= :: GetBucketTagging -> GetBucketTagging -> Bool
== :: GetBucketTagging -> GetBucketTagging -> Bool
$c== :: GetBucketTagging -> GetBucketTagging -> Bool
Prelude.Eq, ReadPrec [GetBucketTagging]
ReadPrec GetBucketTagging
Int -> ReadS GetBucketTagging
ReadS [GetBucketTagging]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetBucketTagging]
$creadListPrec :: ReadPrec [GetBucketTagging]
readPrec :: ReadPrec GetBucketTagging
$creadPrec :: ReadPrec GetBucketTagging
readList :: ReadS [GetBucketTagging]
$creadList :: ReadS [GetBucketTagging]
readsPrec :: Int -> ReadS GetBucketTagging
$creadsPrec :: Int -> ReadS GetBucketTagging
Prelude.Read, Int -> GetBucketTagging -> ShowS
[GetBucketTagging] -> ShowS
GetBucketTagging -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetBucketTagging] -> ShowS
$cshowList :: [GetBucketTagging] -> ShowS
show :: GetBucketTagging -> String
$cshow :: GetBucketTagging -> String
showsPrec :: Int -> GetBucketTagging -> ShowS
$cshowsPrec :: Int -> GetBucketTagging -> ShowS
Prelude.Show, forall x. Rep GetBucketTagging x -> GetBucketTagging
forall x. GetBucketTagging -> Rep GetBucketTagging x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetBucketTagging x -> GetBucketTagging
$cfrom :: forall x. GetBucketTagging -> Rep GetBucketTagging x
Prelude.Generic)

-- |
-- Create a value of 'GetBucketTagging' 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', 'getBucketTagging_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', 'getBucketTagging_bucket' - The name of the bucket for which to get the tagging information.
newGetBucketTagging ::
  -- | 'bucket'
  BucketName ->
  GetBucketTagging
newGetBucketTagging :: BucketName -> GetBucketTagging
newGetBucketTagging BucketName
pBucket_ =
  GetBucketTagging'
    { $sel:expectedBucketOwner:GetBucketTagging' :: Maybe Text
expectedBucketOwner =
        forall a. Maybe a
Prelude.Nothing,
      $sel:bucket:GetBucketTagging' :: 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).
getBucketTagging_expectedBucketOwner :: Lens.Lens' GetBucketTagging (Prelude.Maybe Prelude.Text)
getBucketTagging_expectedBucketOwner :: Lens' GetBucketTagging (Maybe Text)
getBucketTagging_expectedBucketOwner = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetBucketTagging' {Maybe Text
expectedBucketOwner :: Maybe Text
$sel:expectedBucketOwner:GetBucketTagging' :: GetBucketTagging -> Maybe Text
expectedBucketOwner} -> Maybe Text
expectedBucketOwner) (\s :: GetBucketTagging
s@GetBucketTagging' {} Maybe Text
a -> GetBucketTagging
s {$sel:expectedBucketOwner:GetBucketTagging' :: Maybe Text
expectedBucketOwner = Maybe Text
a} :: GetBucketTagging)

-- | The name of the bucket for which to get the tagging information.
getBucketTagging_bucket :: Lens.Lens' GetBucketTagging BucketName
getBucketTagging_bucket :: Lens' GetBucketTagging BucketName
getBucketTagging_bucket = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetBucketTagging' {BucketName
bucket :: BucketName
$sel:bucket:GetBucketTagging' :: GetBucketTagging -> BucketName
bucket} -> BucketName
bucket) (\s :: GetBucketTagging
s@GetBucketTagging' {} BucketName
a -> GetBucketTagging
s {$sel:bucket:GetBucketTagging' :: BucketName
bucket = BucketName
a} :: GetBucketTagging)

instance Core.AWSRequest GetBucketTagging where
  type
    AWSResponse GetBucketTagging =
      GetBucketTaggingResponse
  request :: (Service -> Service)
-> GetBucketTagging -> Request GetBucketTagging
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 GetBucketTagging
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetBucketTagging)))
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 ->
          Int -> [Tag] -> GetBucketTaggingResponse
GetBucketTaggingResponse'
            forall (f :: * -> *) a b. Functor 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))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x
                            forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"TagSet"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                            forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"Tag"
                        )
      )

instance Prelude.Hashable GetBucketTagging where
  hashWithSalt :: Int -> GetBucketTagging -> Int
hashWithSalt Int
_salt GetBucketTagging' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetBucketTagging' :: GetBucketTagging -> BucketName
$sel:expectedBucketOwner:GetBucketTagging' :: GetBucketTagging -> 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 GetBucketTagging where
  rnf :: GetBucketTagging -> ()
rnf GetBucketTagging' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetBucketTagging' :: GetBucketTagging -> BucketName
$sel:expectedBucketOwner:GetBucketTagging' :: GetBucketTagging -> 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 GetBucketTagging where
  toHeaders :: GetBucketTagging -> ResponseHeaders
toHeaders GetBucketTagging' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetBucketTagging' :: GetBucketTagging -> BucketName
$sel:expectedBucketOwner:GetBucketTagging' :: GetBucketTagging -> 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 GetBucketTagging where
  toPath :: GetBucketTagging -> ByteString
toPath GetBucketTagging' {Maybe Text
BucketName
bucket :: BucketName
expectedBucketOwner :: Maybe Text
$sel:bucket:GetBucketTagging' :: GetBucketTagging -> BucketName
$sel:expectedBucketOwner:GetBucketTagging' :: GetBucketTagging -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat [ByteString
"/", forall a. ToByteString a => a -> ByteString
Data.toBS BucketName
bucket]

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

-- | /See:/ 'newGetBucketTaggingResponse' smart constructor.
data GetBucketTaggingResponse = GetBucketTaggingResponse'
  { -- | The response's http status code.
    GetBucketTaggingResponse -> Int
httpStatus :: Prelude.Int,
    -- | Contains the tag set.
    GetBucketTaggingResponse -> [Tag]
tagSet :: [Tag]
  }
  deriving (GetBucketTaggingResponse -> GetBucketTaggingResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetBucketTaggingResponse -> GetBucketTaggingResponse -> Bool
$c/= :: GetBucketTaggingResponse -> GetBucketTaggingResponse -> Bool
== :: GetBucketTaggingResponse -> GetBucketTaggingResponse -> Bool
$c== :: GetBucketTaggingResponse -> GetBucketTaggingResponse -> Bool
Prelude.Eq, ReadPrec [GetBucketTaggingResponse]
ReadPrec GetBucketTaggingResponse
Int -> ReadS GetBucketTaggingResponse
ReadS [GetBucketTaggingResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetBucketTaggingResponse]
$creadListPrec :: ReadPrec [GetBucketTaggingResponse]
readPrec :: ReadPrec GetBucketTaggingResponse
$creadPrec :: ReadPrec GetBucketTaggingResponse
readList :: ReadS [GetBucketTaggingResponse]
$creadList :: ReadS [GetBucketTaggingResponse]
readsPrec :: Int -> ReadS GetBucketTaggingResponse
$creadsPrec :: Int -> ReadS GetBucketTaggingResponse
Prelude.Read, Int -> GetBucketTaggingResponse -> ShowS
[GetBucketTaggingResponse] -> ShowS
GetBucketTaggingResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetBucketTaggingResponse] -> ShowS
$cshowList :: [GetBucketTaggingResponse] -> ShowS
show :: GetBucketTaggingResponse -> String
$cshow :: GetBucketTaggingResponse -> String
showsPrec :: Int -> GetBucketTaggingResponse -> ShowS
$cshowsPrec :: Int -> GetBucketTaggingResponse -> ShowS
Prelude.Show, forall x.
Rep GetBucketTaggingResponse x -> GetBucketTaggingResponse
forall x.
GetBucketTaggingResponse -> Rep GetBucketTaggingResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetBucketTaggingResponse x -> GetBucketTaggingResponse
$cfrom :: forall x.
GetBucketTaggingResponse -> Rep GetBucketTaggingResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetBucketTaggingResponse' 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:
--
-- 'httpStatus', 'getBucketTaggingResponse_httpStatus' - The response's http status code.
--
-- 'tagSet', 'getBucketTaggingResponse_tagSet' - Contains the tag set.
newGetBucketTaggingResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetBucketTaggingResponse
newGetBucketTaggingResponse :: Int -> GetBucketTaggingResponse
newGetBucketTaggingResponse Int
pHttpStatus_ =
  GetBucketTaggingResponse'
    { $sel:httpStatus:GetBucketTaggingResponse' :: Int
httpStatus =
        Int
pHttpStatus_,
      $sel:tagSet:GetBucketTaggingResponse' :: [Tag]
tagSet = forall a. Monoid a => a
Prelude.mempty
    }

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

-- | Contains the tag set.
getBucketTaggingResponse_tagSet :: Lens.Lens' GetBucketTaggingResponse [Tag]
getBucketTaggingResponse_tagSet :: Lens' GetBucketTaggingResponse [Tag]
getBucketTaggingResponse_tagSet = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetBucketTaggingResponse' {[Tag]
tagSet :: [Tag]
$sel:tagSet:GetBucketTaggingResponse' :: GetBucketTaggingResponse -> [Tag]
tagSet} -> [Tag]
tagSet) (\s :: GetBucketTaggingResponse
s@GetBucketTaggingResponse' {} [Tag]
a -> GetBucketTaggingResponse
s {$sel:tagSet:GetBucketTaggingResponse' :: [Tag]
tagSet = [Tag]
a} :: GetBucketTaggingResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.NFData GetBucketTaggingResponse where
  rnf :: GetBucketTaggingResponse -> ()
rnf GetBucketTaggingResponse' {Int
[Tag]
tagSet :: [Tag]
httpStatus :: Int
$sel:tagSet:GetBucketTaggingResponse' :: GetBucketTaggingResponse -> [Tag]
$sel:httpStatus:GetBucketTaggingResponse' :: GetBucketTaggingResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Tag]
tagSet