{-# 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.ListFolders
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists all folders in an account.
module Amazonka.QuickSight.ListFolders
  ( -- * Creating a Request
    ListFolders (..),
    newListFolders,

    -- * Request Lenses
    listFolders_maxResults,
    listFolders_nextToken,
    listFolders_awsAccountId,

    -- * Destructuring the Response
    ListFoldersResponse (..),
    newListFoldersResponse,

    -- * Response Lenses
    listFoldersResponse_folderSummaryList,
    listFoldersResponse_nextToken,
    listFoldersResponse_requestId,
    listFoldersResponse_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:/ 'newListFolders' smart constructor.
data ListFolders = ListFolders'
  { -- | The maximum number of results to be returned per request.
    ListFolders -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token for the next set of results, or null if there are no more
    -- results.
    ListFolders -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The ID for the Amazon Web Services account that contains the folder.
    ListFolders -> Text
awsAccountId :: Prelude.Text
  }
  deriving (ListFolders -> ListFolders -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListFolders -> ListFolders -> Bool
$c/= :: ListFolders -> ListFolders -> Bool
== :: ListFolders -> ListFolders -> Bool
$c== :: ListFolders -> ListFolders -> Bool
Prelude.Eq, ReadPrec [ListFolders]
ReadPrec ListFolders
Int -> ReadS ListFolders
ReadS [ListFolders]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListFolders]
$creadListPrec :: ReadPrec [ListFolders]
readPrec :: ReadPrec ListFolders
$creadPrec :: ReadPrec ListFolders
readList :: ReadS [ListFolders]
$creadList :: ReadS [ListFolders]
readsPrec :: Int -> ReadS ListFolders
$creadsPrec :: Int -> ReadS ListFolders
Prelude.Read, Int -> ListFolders -> ShowS
[ListFolders] -> ShowS
ListFolders -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListFolders] -> ShowS
$cshowList :: [ListFolders] -> ShowS
show :: ListFolders -> String
$cshow :: ListFolders -> String
showsPrec :: Int -> ListFolders -> ShowS
$cshowsPrec :: Int -> ListFolders -> ShowS
Prelude.Show, forall x. Rep ListFolders x -> ListFolders
forall x. ListFolders -> Rep ListFolders x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListFolders x -> ListFolders
$cfrom :: forall x. ListFolders -> Rep ListFolders x
Prelude.Generic)

-- |
-- Create a value of 'ListFolders' 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:
--
-- 'maxResults', 'listFolders_maxResults' - The maximum number of results to be returned per request.
--
-- 'nextToken', 'listFolders_nextToken' - The token for the next set of results, or null if there are no more
-- results.
--
-- 'awsAccountId', 'listFolders_awsAccountId' - The ID for the Amazon Web Services account that contains the folder.
newListFolders ::
  -- | 'awsAccountId'
  Prelude.Text ->
  ListFolders
newListFolders :: Text -> ListFolders
newListFolders Text
pAwsAccountId_ =
  ListFolders'
    { $sel:maxResults:ListFolders' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListFolders' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:awsAccountId:ListFolders' :: Text
awsAccountId = Text
pAwsAccountId_
    }

-- | The maximum number of results to be returned per request.
listFolders_maxResults :: Lens.Lens' ListFolders (Prelude.Maybe Prelude.Natural)
listFolders_maxResults :: Lens' ListFolders (Maybe Natural)
listFolders_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListFolders' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListFolders' :: ListFolders -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListFolders
s@ListFolders' {} Maybe Natural
a -> ListFolders
s {$sel:maxResults:ListFolders' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListFolders)

-- | The token for the next set of results, or null if there are no more
-- results.
listFolders_nextToken :: Lens.Lens' ListFolders (Prelude.Maybe Prelude.Text)
listFolders_nextToken :: Lens' ListFolders (Maybe Text)
listFolders_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListFolders' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListFolders' :: ListFolders -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListFolders
s@ListFolders' {} Maybe Text
a -> ListFolders
s {$sel:nextToken:ListFolders' :: Maybe Text
nextToken = Maybe Text
a} :: ListFolders)

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

instance Core.AWSRequest ListFolders where
  type AWSResponse ListFolders = ListFoldersResponse
  request :: (Service -> Service) -> ListFolders -> Request ListFolders
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 ListFolders
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListFolders)))
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 [FolderSummary]
-> Maybe Text -> Maybe Text -> Int -> ListFoldersResponse
ListFoldersResponse'
            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
"FolderSummaryList"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
            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
"NextToken")
            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 ListFolders where
  hashWithSalt :: Int -> ListFolders -> Int
hashWithSalt Int
_salt ListFolders' {Maybe Natural
Maybe Text
Text
awsAccountId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:awsAccountId:ListFolders' :: ListFolders -> Text
$sel:nextToken:ListFolders' :: ListFolders -> Maybe Text
$sel:maxResults:ListFolders' :: ListFolders -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
awsAccountId

instance Prelude.NFData ListFolders where
  rnf :: ListFolders -> ()
rnf ListFolders' {Maybe Natural
Maybe Text
Text
awsAccountId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:awsAccountId:ListFolders' :: ListFolders -> Text
$sel:nextToken:ListFolders' :: ListFolders -> Maybe Text
$sel:maxResults:ListFolders' :: ListFolders -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
awsAccountId

instance Data.ToHeaders ListFolders where
  toHeaders :: ListFolders -> 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 ListFolders where
  toPath :: ListFolders -> ByteString
toPath ListFolders' {Maybe Natural
Maybe Text
Text
awsAccountId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:awsAccountId:ListFolders' :: ListFolders -> Text
$sel:nextToken:ListFolders' :: ListFolders -> Maybe Text
$sel:maxResults:ListFolders' :: ListFolders -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/accounts/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
awsAccountId, ByteString
"/folders"]

instance Data.ToQuery ListFolders where
  toQuery :: ListFolders -> QueryString
toQuery ListFolders' {Maybe Natural
Maybe Text
Text
awsAccountId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:awsAccountId:ListFolders' :: ListFolders -> Text
$sel:nextToken:ListFolders' :: ListFolders -> Maybe Text
$sel:maxResults:ListFolders' :: ListFolders -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"max-results" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
maxResults,
        ByteString
"next-token" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newListFoldersResponse' smart constructor.
data ListFoldersResponse = ListFoldersResponse'
  { -- | A structure that contains all of the folders in the Amazon Web Services
    -- account. This structure provides basic information about the folders.
    ListFoldersResponse -> Maybe [FolderSummary]
folderSummaryList :: Prelude.Maybe [FolderSummary],
    -- | The token for the next set of results, or null if there are no more
    -- results.
    ListFoldersResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Web Services request ID for this operation.
    ListFoldersResponse -> Maybe Text
requestId :: Prelude.Maybe Prelude.Text,
    -- | The HTTP status of the request.
    ListFoldersResponse -> Int
status :: Prelude.Int
  }
  deriving (ListFoldersResponse -> ListFoldersResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListFoldersResponse -> ListFoldersResponse -> Bool
$c/= :: ListFoldersResponse -> ListFoldersResponse -> Bool
== :: ListFoldersResponse -> ListFoldersResponse -> Bool
$c== :: ListFoldersResponse -> ListFoldersResponse -> Bool
Prelude.Eq, ReadPrec [ListFoldersResponse]
ReadPrec ListFoldersResponse
Int -> ReadS ListFoldersResponse
ReadS [ListFoldersResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListFoldersResponse]
$creadListPrec :: ReadPrec [ListFoldersResponse]
readPrec :: ReadPrec ListFoldersResponse
$creadPrec :: ReadPrec ListFoldersResponse
readList :: ReadS [ListFoldersResponse]
$creadList :: ReadS [ListFoldersResponse]
readsPrec :: Int -> ReadS ListFoldersResponse
$creadsPrec :: Int -> ReadS ListFoldersResponse
Prelude.Read, Int -> ListFoldersResponse -> ShowS
[ListFoldersResponse] -> ShowS
ListFoldersResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListFoldersResponse] -> ShowS
$cshowList :: [ListFoldersResponse] -> ShowS
show :: ListFoldersResponse -> String
$cshow :: ListFoldersResponse -> String
showsPrec :: Int -> ListFoldersResponse -> ShowS
$cshowsPrec :: Int -> ListFoldersResponse -> ShowS
Prelude.Show, forall x. Rep ListFoldersResponse x -> ListFoldersResponse
forall x. ListFoldersResponse -> Rep ListFoldersResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListFoldersResponse x -> ListFoldersResponse
$cfrom :: forall x. ListFoldersResponse -> Rep ListFoldersResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListFoldersResponse' 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:
--
-- 'folderSummaryList', 'listFoldersResponse_folderSummaryList' - A structure that contains all of the folders in the Amazon Web Services
-- account. This structure provides basic information about the folders.
--
-- 'nextToken', 'listFoldersResponse_nextToken' - The token for the next set of results, or null if there are no more
-- results.
--
-- 'requestId', 'listFoldersResponse_requestId' - The Amazon Web Services request ID for this operation.
--
-- 'status', 'listFoldersResponse_status' - The HTTP status of the request.
newListFoldersResponse ::
  -- | 'status'
  Prelude.Int ->
  ListFoldersResponse
newListFoldersResponse :: Int -> ListFoldersResponse
newListFoldersResponse Int
pStatus_ =
  ListFoldersResponse'
    { $sel:folderSummaryList:ListFoldersResponse' :: Maybe [FolderSummary]
folderSummaryList =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListFoldersResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:requestId:ListFoldersResponse' :: Maybe Text
requestId = forall a. Maybe a
Prelude.Nothing,
      $sel:status:ListFoldersResponse' :: Int
status = Int
pStatus_
    }

-- | A structure that contains all of the folders in the Amazon Web Services
-- account. This structure provides basic information about the folders.
listFoldersResponse_folderSummaryList :: Lens.Lens' ListFoldersResponse (Prelude.Maybe [FolderSummary])
listFoldersResponse_folderSummaryList :: Lens' ListFoldersResponse (Maybe [FolderSummary])
listFoldersResponse_folderSummaryList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListFoldersResponse' {Maybe [FolderSummary]
folderSummaryList :: Maybe [FolderSummary]
$sel:folderSummaryList:ListFoldersResponse' :: ListFoldersResponse -> Maybe [FolderSummary]
folderSummaryList} -> Maybe [FolderSummary]
folderSummaryList) (\s :: ListFoldersResponse
s@ListFoldersResponse' {} Maybe [FolderSummary]
a -> ListFoldersResponse
s {$sel:folderSummaryList:ListFoldersResponse' :: Maybe [FolderSummary]
folderSummaryList = Maybe [FolderSummary]
a} :: ListFoldersResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The token for the next set of results, or null if there are no more
-- results.
listFoldersResponse_nextToken :: Lens.Lens' ListFoldersResponse (Prelude.Maybe Prelude.Text)
listFoldersResponse_nextToken :: Lens' ListFoldersResponse (Maybe Text)
listFoldersResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListFoldersResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListFoldersResponse' :: ListFoldersResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListFoldersResponse
s@ListFoldersResponse' {} Maybe Text
a -> ListFoldersResponse
s {$sel:nextToken:ListFoldersResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListFoldersResponse)

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

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

instance Prelude.NFData ListFoldersResponse where
  rnf :: ListFoldersResponse -> ()
rnf ListFoldersResponse' {Int
Maybe [FolderSummary]
Maybe Text
status :: Int
requestId :: Maybe Text
nextToken :: Maybe Text
folderSummaryList :: Maybe [FolderSummary]
$sel:status:ListFoldersResponse' :: ListFoldersResponse -> Int
$sel:requestId:ListFoldersResponse' :: ListFoldersResponse -> Maybe Text
$sel:nextToken:ListFoldersResponse' :: ListFoldersResponse -> Maybe Text
$sel:folderSummaryList:ListFoldersResponse' :: ListFoldersResponse -> Maybe [FolderSummary]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [FolderSummary]
folderSummaryList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      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