{-# 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.CloudDirectory.ListDirectories
-- 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 directories created within an account.
--
-- This operation returns paginated results.
module Amazonka.CloudDirectory.ListDirectories
  ( -- * Creating a Request
    ListDirectories (..),
    newListDirectories,

    -- * Request Lenses
    listDirectories_maxResults,
    listDirectories_nextToken,
    listDirectories_state,

    -- * Destructuring the Response
    ListDirectoriesResponse (..),
    newListDirectoriesResponse,

    -- * Response Lenses
    listDirectoriesResponse_nextToken,
    listDirectoriesResponse_httpStatus,
    listDirectoriesResponse_directories,
  )
where

import Amazonka.CloudDirectory.Types
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

-- | /See:/ 'newListDirectories' smart constructor.
data ListDirectories = ListDirectories'
  { -- | The maximum number of results to retrieve.
    ListDirectories -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The pagination token.
    ListDirectories -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The state of the directories in the list. Can be either Enabled,
    -- Disabled, or Deleted.
    ListDirectories -> Maybe DirectoryState
state :: Prelude.Maybe DirectoryState
  }
  deriving (ListDirectories -> ListDirectories -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListDirectories -> ListDirectories -> Bool
$c/= :: ListDirectories -> ListDirectories -> Bool
== :: ListDirectories -> ListDirectories -> Bool
$c== :: ListDirectories -> ListDirectories -> Bool
Prelude.Eq, ReadPrec [ListDirectories]
ReadPrec ListDirectories
Int -> ReadS ListDirectories
ReadS [ListDirectories]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListDirectories]
$creadListPrec :: ReadPrec [ListDirectories]
readPrec :: ReadPrec ListDirectories
$creadPrec :: ReadPrec ListDirectories
readList :: ReadS [ListDirectories]
$creadList :: ReadS [ListDirectories]
readsPrec :: Int -> ReadS ListDirectories
$creadsPrec :: Int -> ReadS ListDirectories
Prelude.Read, Int -> ListDirectories -> ShowS
[ListDirectories] -> ShowS
ListDirectories -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListDirectories] -> ShowS
$cshowList :: [ListDirectories] -> ShowS
show :: ListDirectories -> String
$cshow :: ListDirectories -> String
showsPrec :: Int -> ListDirectories -> ShowS
$cshowsPrec :: Int -> ListDirectories -> ShowS
Prelude.Show, forall x. Rep ListDirectories x -> ListDirectories
forall x. ListDirectories -> Rep ListDirectories x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListDirectories x -> ListDirectories
$cfrom :: forall x. ListDirectories -> Rep ListDirectories x
Prelude.Generic)

-- |
-- Create a value of 'ListDirectories' 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', 'listDirectories_maxResults' - The maximum number of results to retrieve.
--
-- 'nextToken', 'listDirectories_nextToken' - The pagination token.
--
-- 'state', 'listDirectories_state' - The state of the directories in the list. Can be either Enabled,
-- Disabled, or Deleted.
newListDirectories ::
  ListDirectories
newListDirectories :: ListDirectories
newListDirectories =
  ListDirectories'
    { $sel:maxResults:ListDirectories' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListDirectories' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:state:ListDirectories' :: Maybe DirectoryState
state = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to retrieve.
listDirectories_maxResults :: Lens.Lens' ListDirectories (Prelude.Maybe Prelude.Natural)
listDirectories_maxResults :: Lens' ListDirectories (Maybe Natural)
listDirectories_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDirectories' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListDirectories' :: ListDirectories -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListDirectories
s@ListDirectories' {} Maybe Natural
a -> ListDirectories
s {$sel:maxResults:ListDirectories' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListDirectories)

-- | The pagination token.
listDirectories_nextToken :: Lens.Lens' ListDirectories (Prelude.Maybe Prelude.Text)
listDirectories_nextToken :: Lens' ListDirectories (Maybe Text)
listDirectories_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDirectories' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListDirectories' :: ListDirectories -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListDirectories
s@ListDirectories' {} Maybe Text
a -> ListDirectories
s {$sel:nextToken:ListDirectories' :: Maybe Text
nextToken = Maybe Text
a} :: ListDirectories)

-- | The state of the directories in the list. Can be either Enabled,
-- Disabled, or Deleted.
listDirectories_state :: Lens.Lens' ListDirectories (Prelude.Maybe DirectoryState)
listDirectories_state :: Lens' ListDirectories (Maybe DirectoryState)
listDirectories_state = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDirectories' {Maybe DirectoryState
state :: Maybe DirectoryState
$sel:state:ListDirectories' :: ListDirectories -> Maybe DirectoryState
state} -> Maybe DirectoryState
state) (\s :: ListDirectories
s@ListDirectories' {} Maybe DirectoryState
a -> ListDirectories
s {$sel:state:ListDirectories' :: Maybe DirectoryState
state = Maybe DirectoryState
a} :: ListDirectories)

instance Core.AWSPager ListDirectories where
  page :: ListDirectories
-> AWSResponse ListDirectories -> Maybe ListDirectories
page ListDirectories
rq AWSResponse ListDirectories
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListDirectories
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListDirectoriesResponse (Maybe Text)
listDirectoriesResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        (AWSResponse ListDirectories
rs forall s a. s -> Getting a s a -> a
Lens.^. Lens' ListDirectoriesResponse [Directory]
listDirectoriesResponse_directories) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListDirectories
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListDirectories (Maybe Text)
listDirectories_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListDirectories
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListDirectoriesResponse (Maybe Text)
listDirectoriesResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest ListDirectories where
  type
    AWSResponse ListDirectories =
      ListDirectoriesResponse
  request :: (Service -> Service) -> ListDirectories -> Request ListDirectories
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListDirectories
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListDirectories)))
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 Text -> Int -> [Directory] -> ListDirectoriesResponse
ListDirectoriesResponse'
            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
"NextToken")
            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))
            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
"Directories" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable ListDirectories where
  hashWithSalt :: Int -> ListDirectories -> Int
hashWithSalt Int
_salt ListDirectories' {Maybe Natural
Maybe Text
Maybe DirectoryState
state :: Maybe DirectoryState
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:state:ListDirectories' :: ListDirectories -> Maybe DirectoryState
$sel:nextToken:ListDirectories' :: ListDirectories -> Maybe Text
$sel:maxResults:ListDirectories' :: ListDirectories -> 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` Maybe DirectoryState
state

instance Prelude.NFData ListDirectories where
  rnf :: ListDirectories -> ()
rnf ListDirectories' {Maybe Natural
Maybe Text
Maybe DirectoryState
state :: Maybe DirectoryState
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:state:ListDirectories' :: ListDirectories -> Maybe DirectoryState
$sel:nextToken:ListDirectories' :: ListDirectories -> Maybe Text
$sel:maxResults:ListDirectories' :: ListDirectories -> 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 Maybe DirectoryState
state

instance Data.ToHeaders ListDirectories where
  toHeaders :: ListDirectories -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToJSON ListDirectories where
  toJSON :: ListDirectories -> Value
toJSON ListDirectories' {Maybe Natural
Maybe Text
Maybe DirectoryState
state :: Maybe DirectoryState
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:state:ListDirectories' :: ListDirectories -> Maybe DirectoryState
$sel:nextToken:ListDirectories' :: ListDirectories -> Maybe Text
$sel:maxResults:ListDirectories' :: ListDirectories -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"MaxResults" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults,
            (Key
"NextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken,
            (Key
"state" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe DirectoryState
state
          ]
      )

instance Data.ToPath ListDirectories where
  toPath :: ListDirectories -> ByteString
toPath =
    forall a b. a -> b -> a
Prelude.const
      ByteString
"/amazonclouddirectory/2017-01-11/directory/list"

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

-- | /See:/ 'newListDirectoriesResponse' smart constructor.
data ListDirectoriesResponse = ListDirectoriesResponse'
  { -- | The pagination token.
    ListDirectoriesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListDirectoriesResponse -> Int
httpStatus :: Prelude.Int,
    -- | Lists all directories that are associated with your account in
    -- pagination fashion.
    ListDirectoriesResponse -> [Directory]
directories :: [Directory]
  }
  deriving (ListDirectoriesResponse -> ListDirectoriesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListDirectoriesResponse -> ListDirectoriesResponse -> Bool
$c/= :: ListDirectoriesResponse -> ListDirectoriesResponse -> Bool
== :: ListDirectoriesResponse -> ListDirectoriesResponse -> Bool
$c== :: ListDirectoriesResponse -> ListDirectoriesResponse -> Bool
Prelude.Eq, ReadPrec [ListDirectoriesResponse]
ReadPrec ListDirectoriesResponse
Int -> ReadS ListDirectoriesResponse
ReadS [ListDirectoriesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListDirectoriesResponse]
$creadListPrec :: ReadPrec [ListDirectoriesResponse]
readPrec :: ReadPrec ListDirectoriesResponse
$creadPrec :: ReadPrec ListDirectoriesResponse
readList :: ReadS [ListDirectoriesResponse]
$creadList :: ReadS [ListDirectoriesResponse]
readsPrec :: Int -> ReadS ListDirectoriesResponse
$creadsPrec :: Int -> ReadS ListDirectoriesResponse
Prelude.Read, Int -> ListDirectoriesResponse -> ShowS
[ListDirectoriesResponse] -> ShowS
ListDirectoriesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListDirectoriesResponse] -> ShowS
$cshowList :: [ListDirectoriesResponse] -> ShowS
show :: ListDirectoriesResponse -> String
$cshow :: ListDirectoriesResponse -> String
showsPrec :: Int -> ListDirectoriesResponse -> ShowS
$cshowsPrec :: Int -> ListDirectoriesResponse -> ShowS
Prelude.Show, forall x. Rep ListDirectoriesResponse x -> ListDirectoriesResponse
forall x. ListDirectoriesResponse -> Rep ListDirectoriesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListDirectoriesResponse x -> ListDirectoriesResponse
$cfrom :: forall x. ListDirectoriesResponse -> Rep ListDirectoriesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListDirectoriesResponse' 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:
--
-- 'nextToken', 'listDirectoriesResponse_nextToken' - The pagination token.
--
-- 'httpStatus', 'listDirectoriesResponse_httpStatus' - The response's http status code.
--
-- 'directories', 'listDirectoriesResponse_directories' - Lists all directories that are associated with your account in
-- pagination fashion.
newListDirectoriesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListDirectoriesResponse
newListDirectoriesResponse :: Int -> ListDirectoriesResponse
newListDirectoriesResponse Int
pHttpStatus_ =
  ListDirectoriesResponse'
    { $sel:nextToken:ListDirectoriesResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListDirectoriesResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:directories:ListDirectoriesResponse' :: [Directory]
directories = forall a. Monoid a => a
Prelude.mempty
    }

-- | The pagination token.
listDirectoriesResponse_nextToken :: Lens.Lens' ListDirectoriesResponse (Prelude.Maybe Prelude.Text)
listDirectoriesResponse_nextToken :: Lens' ListDirectoriesResponse (Maybe Text)
listDirectoriesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDirectoriesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListDirectoriesResponse' :: ListDirectoriesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListDirectoriesResponse
s@ListDirectoriesResponse' {} Maybe Text
a -> ListDirectoriesResponse
s {$sel:nextToken:ListDirectoriesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListDirectoriesResponse)

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

-- | Lists all directories that are associated with your account in
-- pagination fashion.
listDirectoriesResponse_directories :: Lens.Lens' ListDirectoriesResponse [Directory]
listDirectoriesResponse_directories :: Lens' ListDirectoriesResponse [Directory]
listDirectoriesResponse_directories = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListDirectoriesResponse' {[Directory]
directories :: [Directory]
$sel:directories:ListDirectoriesResponse' :: ListDirectoriesResponse -> [Directory]
directories} -> [Directory]
directories) (\s :: ListDirectoriesResponse
s@ListDirectoriesResponse' {} [Directory]
a -> ListDirectoriesResponse
s {$sel:directories:ListDirectoriesResponse' :: [Directory]
directories = [Directory]
a} :: ListDirectoriesResponse) 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 ListDirectoriesResponse where
  rnf :: ListDirectoriesResponse -> ()
rnf ListDirectoriesResponse' {Int
[Directory]
Maybe Text
directories :: [Directory]
httpStatus :: Int
nextToken :: Maybe Text
$sel:directories:ListDirectoriesResponse' :: ListDirectoriesResponse -> [Directory]
$sel:httpStatus:ListDirectoriesResponse' :: ListDirectoriesResponse -> Int
$sel:nextToken:ListDirectoriesResponse' :: ListDirectoriesResponse -> Maybe Text
..} =
    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 Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Directory]
directories