{-# 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.QuickSight.DescribeFolder
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes a folder.
module Amazonka.QuickSight.DescribeFolder
  ( -- * Creating a Request
    DescribeFolder (..),
    newDescribeFolder,

    -- * Request Lenses
    describeFolder_awsAccountId,
    describeFolder_folderId,

    -- * Destructuring the Response
    DescribeFolderResponse (..),
    newDescribeFolderResponse,

    -- * Response Lenses
    describeFolderResponse_folder,
    describeFolderResponse_requestId,
    describeFolderResponse_status,
  )
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 Amazonka.QuickSight.Types
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeFolder' smart constructor.
data DescribeFolder = DescribeFolder'
  { -- | The ID for the Amazon Web Services account that contains the folder.
    DescribeFolder -> Text
awsAccountId :: Prelude.Text,
    -- | The ID of the folder.
    DescribeFolder -> Text
folderId :: Prelude.Text
  }
  deriving (DescribeFolder -> DescribeFolder -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFolder -> DescribeFolder -> Bool
$c/= :: DescribeFolder -> DescribeFolder -> Bool
== :: DescribeFolder -> DescribeFolder -> Bool
$c== :: DescribeFolder -> DescribeFolder -> Bool
Prelude.Eq, ReadPrec [DescribeFolder]
ReadPrec DescribeFolder
Int -> ReadS DescribeFolder
ReadS [DescribeFolder]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFolder]
$creadListPrec :: ReadPrec [DescribeFolder]
readPrec :: ReadPrec DescribeFolder
$creadPrec :: ReadPrec DescribeFolder
readList :: ReadS [DescribeFolder]
$creadList :: ReadS [DescribeFolder]
readsPrec :: Int -> ReadS DescribeFolder
$creadsPrec :: Int -> ReadS DescribeFolder
Prelude.Read, Int -> DescribeFolder -> ShowS
[DescribeFolder] -> ShowS
DescribeFolder -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFolder] -> ShowS
$cshowList :: [DescribeFolder] -> ShowS
show :: DescribeFolder -> String
$cshow :: DescribeFolder -> String
showsPrec :: Int -> DescribeFolder -> ShowS
$cshowsPrec :: Int -> DescribeFolder -> ShowS
Prelude.Show, forall x. Rep DescribeFolder x -> DescribeFolder
forall x. DescribeFolder -> Rep DescribeFolder x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFolder x -> DescribeFolder
$cfrom :: forall x. DescribeFolder -> Rep DescribeFolder x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFolder' 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:
--
-- 'awsAccountId', 'describeFolder_awsAccountId' - The ID for the Amazon Web Services account that contains the folder.
--
-- 'folderId', 'describeFolder_folderId' - The ID of the folder.
newDescribeFolder ::
  -- | 'awsAccountId'
  Prelude.Text ->
  -- | 'folderId'
  Prelude.Text ->
  DescribeFolder
newDescribeFolder :: Text -> Text -> DescribeFolder
newDescribeFolder Text
pAwsAccountId_ Text
pFolderId_ =
  DescribeFolder'
    { $sel:awsAccountId:DescribeFolder' :: Text
awsAccountId = Text
pAwsAccountId_,
      $sel:folderId:DescribeFolder' :: Text
folderId = Text
pFolderId_
    }

-- | The ID for the Amazon Web Services account that contains the folder.
describeFolder_awsAccountId :: Lens.Lens' DescribeFolder Prelude.Text
describeFolder_awsAccountId :: Lens' DescribeFolder Text
describeFolder_awsAccountId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFolder' {Text
awsAccountId :: Text
$sel:awsAccountId:DescribeFolder' :: DescribeFolder -> Text
awsAccountId} -> Text
awsAccountId) (\s :: DescribeFolder
s@DescribeFolder' {} Text
a -> DescribeFolder
s {$sel:awsAccountId:DescribeFolder' :: Text
awsAccountId = Text
a} :: DescribeFolder)

-- | The ID of the folder.
describeFolder_folderId :: Lens.Lens' DescribeFolder Prelude.Text
describeFolder_folderId :: Lens' DescribeFolder Text
describeFolder_folderId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFolder' {Text
folderId :: Text
$sel:folderId:DescribeFolder' :: DescribeFolder -> Text
folderId} -> Text
folderId) (\s :: DescribeFolder
s@DescribeFolder' {} Text
a -> DescribeFolder
s {$sel:folderId:DescribeFolder' :: Text
folderId = Text
a} :: DescribeFolder)

instance Core.AWSRequest DescribeFolder where
  type
    AWSResponse DescribeFolder =
      DescribeFolderResponse
  request :: (Service -> Service) -> DescribeFolder -> Request DescribeFolder
request Service -> Service
overrides =
    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 DescribeFolder
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeFolder)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Folder -> Maybe Text -> Int -> DescribeFolderResponse
DescribeFolderResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Folder")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"RequestId")
            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 DescribeFolder where
  hashWithSalt :: Int -> DescribeFolder -> Int
hashWithSalt Int
_salt DescribeFolder' {Text
folderId :: Text
awsAccountId :: Text
$sel:folderId:DescribeFolder' :: DescribeFolder -> Text
$sel:awsAccountId:DescribeFolder' :: DescribeFolder -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
awsAccountId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
folderId

instance Prelude.NFData DescribeFolder where
  rnf :: DescribeFolder -> ()
rnf DescribeFolder' {Text
folderId :: Text
awsAccountId :: Text
$sel:folderId:DescribeFolder' :: DescribeFolder -> Text
$sel:awsAccountId:DescribeFolder' :: DescribeFolder -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
awsAccountId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
folderId

instance Data.ToHeaders DescribeFolder where
  toHeaders :: DescribeFolder -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.0" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToPath DescribeFolder where
  toPath :: DescribeFolder -> ByteString
toPath DescribeFolder' {Text
folderId :: Text
awsAccountId :: Text
$sel:folderId:DescribeFolder' :: DescribeFolder -> Text
$sel:awsAccountId:DescribeFolder' :: DescribeFolder -> Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/accounts/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
awsAccountId,
        ByteString
"/folders/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
folderId
      ]

instance Data.ToQuery DescribeFolder where
  toQuery :: DescribeFolder -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newDescribeFolderResponse' smart constructor.
data DescribeFolderResponse = DescribeFolderResponse'
  { -- | Information about the folder.
    DescribeFolderResponse -> Maybe Folder
folder :: Prelude.Maybe Folder,
    -- | The Amazon Web Services request ID for this operation.
    DescribeFolderResponse -> Maybe Text
requestId :: Prelude.Maybe Prelude.Text,
    -- | The HTTP status of the request.
    DescribeFolderResponse -> Int
status :: Prelude.Int
  }
  deriving (DescribeFolderResponse -> DescribeFolderResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFolderResponse -> DescribeFolderResponse -> Bool
$c/= :: DescribeFolderResponse -> DescribeFolderResponse -> Bool
== :: DescribeFolderResponse -> DescribeFolderResponse -> Bool
$c== :: DescribeFolderResponse -> DescribeFolderResponse -> Bool
Prelude.Eq, ReadPrec [DescribeFolderResponse]
ReadPrec DescribeFolderResponse
Int -> ReadS DescribeFolderResponse
ReadS [DescribeFolderResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFolderResponse]
$creadListPrec :: ReadPrec [DescribeFolderResponse]
readPrec :: ReadPrec DescribeFolderResponse
$creadPrec :: ReadPrec DescribeFolderResponse
readList :: ReadS [DescribeFolderResponse]
$creadList :: ReadS [DescribeFolderResponse]
readsPrec :: Int -> ReadS DescribeFolderResponse
$creadsPrec :: Int -> ReadS DescribeFolderResponse
Prelude.Read, Int -> DescribeFolderResponse -> ShowS
[DescribeFolderResponse] -> ShowS
DescribeFolderResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFolderResponse] -> ShowS
$cshowList :: [DescribeFolderResponse] -> ShowS
show :: DescribeFolderResponse -> String
$cshow :: DescribeFolderResponse -> String
showsPrec :: Int -> DescribeFolderResponse -> ShowS
$cshowsPrec :: Int -> DescribeFolderResponse -> ShowS
Prelude.Show, forall x. Rep DescribeFolderResponse x -> DescribeFolderResponse
forall x. DescribeFolderResponse -> Rep DescribeFolderResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFolderResponse x -> DescribeFolderResponse
$cfrom :: forall x. DescribeFolderResponse -> Rep DescribeFolderResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFolderResponse' 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:
--
-- 'folder', 'describeFolderResponse_folder' - Information about the folder.
--
-- 'requestId', 'describeFolderResponse_requestId' - The Amazon Web Services request ID for this operation.
--
-- 'status', 'describeFolderResponse_status' - The HTTP status of the request.
newDescribeFolderResponse ::
  -- | 'status'
  Prelude.Int ->
  DescribeFolderResponse
newDescribeFolderResponse :: Int -> DescribeFolderResponse
newDescribeFolderResponse Int
pStatus_ =
  DescribeFolderResponse'
    { $sel:folder:DescribeFolderResponse' :: Maybe Folder
folder = forall a. Maybe a
Prelude.Nothing,
      $sel:requestId:DescribeFolderResponse' :: Maybe Text
requestId = forall a. Maybe a
Prelude.Nothing,
      $sel:status:DescribeFolderResponse' :: Int
status = Int
pStatus_
    }

-- | Information about the folder.
describeFolderResponse_folder :: Lens.Lens' DescribeFolderResponse (Prelude.Maybe Folder)
describeFolderResponse_folder :: Lens' DescribeFolderResponse (Maybe Folder)
describeFolderResponse_folder = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFolderResponse' {Maybe Folder
folder :: Maybe Folder
$sel:folder:DescribeFolderResponse' :: DescribeFolderResponse -> Maybe Folder
folder} -> Maybe Folder
folder) (\s :: DescribeFolderResponse
s@DescribeFolderResponse' {} Maybe Folder
a -> DescribeFolderResponse
s {$sel:folder:DescribeFolderResponse' :: Maybe Folder
folder = Maybe Folder
a} :: DescribeFolderResponse)

-- | The Amazon Web Services request ID for this operation.
describeFolderResponse_requestId :: Lens.Lens' DescribeFolderResponse (Prelude.Maybe Prelude.Text)
describeFolderResponse_requestId :: Lens' DescribeFolderResponse (Maybe Text)
describeFolderResponse_requestId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFolderResponse' {Maybe Text
requestId :: Maybe Text
$sel:requestId:DescribeFolderResponse' :: DescribeFolderResponse -> Maybe Text
requestId} -> Maybe Text
requestId) (\s :: DescribeFolderResponse
s@DescribeFolderResponse' {} Maybe Text
a -> DescribeFolderResponse
s {$sel:requestId:DescribeFolderResponse' :: Maybe Text
requestId = Maybe Text
a} :: DescribeFolderResponse)

-- | The HTTP status of the request.
describeFolderResponse_status :: Lens.Lens' DescribeFolderResponse Prelude.Int
describeFolderResponse_status :: Lens' DescribeFolderResponse Int
describeFolderResponse_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFolderResponse' {Int
status :: Int
$sel:status:DescribeFolderResponse' :: DescribeFolderResponse -> Int
status} -> Int
status) (\s :: DescribeFolderResponse
s@DescribeFolderResponse' {} Int
a -> DescribeFolderResponse
s {$sel:status:DescribeFolderResponse' :: Int
status = Int
a} :: DescribeFolderResponse)

instance Prelude.NFData DescribeFolderResponse where
  rnf :: DescribeFolderResponse -> ()
rnf DescribeFolderResponse' {Int
Maybe Text
Maybe Folder
status :: Int
requestId :: Maybe Text
folder :: Maybe Folder
$sel:status:DescribeFolderResponse' :: DescribeFolderResponse -> Int
$sel:requestId:DescribeFolderResponse' :: DescribeFolderResponse -> Maybe Text
$sel:folder:DescribeFolderResponse' :: DescribeFolderResponse -> Maybe Folder
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Folder
folder
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
requestId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
status