{-# 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.FinSpaceData.ListPermissionGroups
-- 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 available permission groups in FinSpace.
--
-- This operation returns paginated results.
module Amazonka.FinSpaceData.ListPermissionGroups
  ( -- * Creating a Request
    ListPermissionGroups (..),
    newListPermissionGroups,

    -- * Request Lenses
    listPermissionGroups_nextToken,
    listPermissionGroups_maxResults,

    -- * Destructuring the Response
    ListPermissionGroupsResponse (..),
    newListPermissionGroupsResponse,

    -- * Response Lenses
    listPermissionGroupsResponse_nextToken,
    listPermissionGroupsResponse_permissionGroups,
    listPermissionGroupsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListPermissionGroups' smart constructor.
data ListPermissionGroups = ListPermissionGroups'
  { -- | A token that indicates where a results page should begin.
    ListPermissionGroups -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The maximum number of results per page.
    ListPermissionGroups -> Natural
maxResults :: Prelude.Natural
  }
  deriving (ListPermissionGroups -> ListPermissionGroups -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListPermissionGroups -> ListPermissionGroups -> Bool
$c/= :: ListPermissionGroups -> ListPermissionGroups -> Bool
== :: ListPermissionGroups -> ListPermissionGroups -> Bool
$c== :: ListPermissionGroups -> ListPermissionGroups -> Bool
Prelude.Eq, ReadPrec [ListPermissionGroups]
ReadPrec ListPermissionGroups
Int -> ReadS ListPermissionGroups
ReadS [ListPermissionGroups]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListPermissionGroups]
$creadListPrec :: ReadPrec [ListPermissionGroups]
readPrec :: ReadPrec ListPermissionGroups
$creadPrec :: ReadPrec ListPermissionGroups
readList :: ReadS [ListPermissionGroups]
$creadList :: ReadS [ListPermissionGroups]
readsPrec :: Int -> ReadS ListPermissionGroups
$creadsPrec :: Int -> ReadS ListPermissionGroups
Prelude.Read, Int -> ListPermissionGroups -> ShowS
[ListPermissionGroups] -> ShowS
ListPermissionGroups -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListPermissionGroups] -> ShowS
$cshowList :: [ListPermissionGroups] -> ShowS
show :: ListPermissionGroups -> String
$cshow :: ListPermissionGroups -> String
showsPrec :: Int -> ListPermissionGroups -> ShowS
$cshowsPrec :: Int -> ListPermissionGroups -> ShowS
Prelude.Show, forall x. Rep ListPermissionGroups x -> ListPermissionGroups
forall x. ListPermissionGroups -> Rep ListPermissionGroups x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListPermissionGroups x -> ListPermissionGroups
$cfrom :: forall x. ListPermissionGroups -> Rep ListPermissionGroups x
Prelude.Generic)

-- |
-- Create a value of 'ListPermissionGroups' 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', 'listPermissionGroups_nextToken' - A token that indicates where a results page should begin.
--
-- 'maxResults', 'listPermissionGroups_maxResults' - The maximum number of results per page.
newListPermissionGroups ::
  -- | 'maxResults'
  Prelude.Natural ->
  ListPermissionGroups
newListPermissionGroups :: Natural -> ListPermissionGroups
newListPermissionGroups Natural
pMaxResults_ =
  ListPermissionGroups'
    { $sel:nextToken:ListPermissionGroups' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:ListPermissionGroups' :: Natural
maxResults = Natural
pMaxResults_
    }

-- | A token that indicates where a results page should begin.
listPermissionGroups_nextToken :: Lens.Lens' ListPermissionGroups (Prelude.Maybe Prelude.Text)
listPermissionGroups_nextToken :: Lens' ListPermissionGroups (Maybe Text)
listPermissionGroups_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPermissionGroups' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListPermissionGroups' :: ListPermissionGroups -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListPermissionGroups
s@ListPermissionGroups' {} Maybe Text
a -> ListPermissionGroups
s {$sel:nextToken:ListPermissionGroups' :: Maybe Text
nextToken = Maybe Text
a} :: ListPermissionGroups)

-- | The maximum number of results per page.
listPermissionGroups_maxResults :: Lens.Lens' ListPermissionGroups Prelude.Natural
listPermissionGroups_maxResults :: Lens' ListPermissionGroups Natural
listPermissionGroups_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPermissionGroups' {Natural
maxResults :: Natural
$sel:maxResults:ListPermissionGroups' :: ListPermissionGroups -> Natural
maxResults} -> Natural
maxResults) (\s :: ListPermissionGroups
s@ListPermissionGroups' {} Natural
a -> ListPermissionGroups
s {$sel:maxResults:ListPermissionGroups' :: Natural
maxResults = Natural
a} :: ListPermissionGroups)

instance Core.AWSPager ListPermissionGroups where
  page :: ListPermissionGroups
-> AWSResponse ListPermissionGroups -> Maybe ListPermissionGroups
page ListPermissionGroups
rq AWSResponse ListPermissionGroups
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListPermissionGroups
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListPermissionGroupsResponse (Maybe Text)
listPermissionGroupsResponse_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 ListPermissionGroups
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListPermissionGroupsResponse (Maybe [PermissionGroup])
listPermissionGroupsResponse_permissionGroups
            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
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListPermissionGroups
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListPermissionGroups (Maybe Text)
listPermissionGroups_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListPermissionGroups
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListPermissionGroupsResponse (Maybe Text)
listPermissionGroupsResponse_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 ListPermissionGroups where
  type
    AWSResponse ListPermissionGroups =
      ListPermissionGroupsResponse
  request :: (Service -> Service)
-> ListPermissionGroups -> Request ListPermissionGroups
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 ListPermissionGroups
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ListPermissionGroups)))
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
-> Maybe [PermissionGroup] -> Int -> ListPermissionGroupsResponse
ListPermissionGroupsResponse'
            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.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"permissionGroups"
                            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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListPermissionGroups where
  hashWithSalt :: Int -> ListPermissionGroups -> Int
hashWithSalt Int
_salt ListPermissionGroups' {Natural
Maybe Text
maxResults :: Natural
nextToken :: Maybe Text
$sel:maxResults:ListPermissionGroups' :: ListPermissionGroups -> Natural
$sel:nextToken:ListPermissionGroups' :: ListPermissionGroups -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
maxResults

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

instance Data.ToHeaders ListPermissionGroups where
  toHeaders :: ListPermissionGroups -> 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.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToPath ListPermissionGroups where
  toPath :: ListPermissionGroups -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/permission-group"

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

-- | /See:/ 'newListPermissionGroupsResponse' smart constructor.
data ListPermissionGroupsResponse = ListPermissionGroupsResponse'
  { -- | A token that indicates where a results page should begin.
    ListPermissionGroupsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A list of all the permission groups.
    ListPermissionGroupsResponse -> Maybe [PermissionGroup]
permissionGroups :: Prelude.Maybe [PermissionGroup],
    -- | The response's http status code.
    ListPermissionGroupsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListPermissionGroupsResponse
-> ListPermissionGroupsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListPermissionGroupsResponse
-> ListPermissionGroupsResponse -> Bool
$c/= :: ListPermissionGroupsResponse
-> ListPermissionGroupsResponse -> Bool
== :: ListPermissionGroupsResponse
-> ListPermissionGroupsResponse -> Bool
$c== :: ListPermissionGroupsResponse
-> ListPermissionGroupsResponse -> Bool
Prelude.Eq, Int -> ListPermissionGroupsResponse -> ShowS
[ListPermissionGroupsResponse] -> ShowS
ListPermissionGroupsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListPermissionGroupsResponse] -> ShowS
$cshowList :: [ListPermissionGroupsResponse] -> ShowS
show :: ListPermissionGroupsResponse -> String
$cshow :: ListPermissionGroupsResponse -> String
showsPrec :: Int -> ListPermissionGroupsResponse -> ShowS
$cshowsPrec :: Int -> ListPermissionGroupsResponse -> ShowS
Prelude.Show, forall x.
Rep ListPermissionGroupsResponse x -> ListPermissionGroupsResponse
forall x.
ListPermissionGroupsResponse -> Rep ListPermissionGroupsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListPermissionGroupsResponse x -> ListPermissionGroupsResponse
$cfrom :: forall x.
ListPermissionGroupsResponse -> Rep ListPermissionGroupsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListPermissionGroupsResponse' 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', 'listPermissionGroupsResponse_nextToken' - A token that indicates where a results page should begin.
--
-- 'permissionGroups', 'listPermissionGroupsResponse_permissionGroups' - A list of all the permission groups.
--
-- 'httpStatus', 'listPermissionGroupsResponse_httpStatus' - The response's http status code.
newListPermissionGroupsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListPermissionGroupsResponse
newListPermissionGroupsResponse :: Int -> ListPermissionGroupsResponse
newListPermissionGroupsResponse Int
pHttpStatus_ =
  ListPermissionGroupsResponse'
    { $sel:nextToken:ListPermissionGroupsResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:permissionGroups:ListPermissionGroupsResponse' :: Maybe [PermissionGroup]
permissionGroups = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListPermissionGroupsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A token that indicates where a results page should begin.
listPermissionGroupsResponse_nextToken :: Lens.Lens' ListPermissionGroupsResponse (Prelude.Maybe Prelude.Text)
listPermissionGroupsResponse_nextToken :: Lens' ListPermissionGroupsResponse (Maybe Text)
listPermissionGroupsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPermissionGroupsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListPermissionGroupsResponse' :: ListPermissionGroupsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListPermissionGroupsResponse
s@ListPermissionGroupsResponse' {} Maybe Text
a -> ListPermissionGroupsResponse
s {$sel:nextToken:ListPermissionGroupsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListPermissionGroupsResponse)

-- | A list of all the permission groups.
listPermissionGroupsResponse_permissionGroups :: Lens.Lens' ListPermissionGroupsResponse (Prelude.Maybe [PermissionGroup])
listPermissionGroupsResponse_permissionGroups :: Lens' ListPermissionGroupsResponse (Maybe [PermissionGroup])
listPermissionGroupsResponse_permissionGroups = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPermissionGroupsResponse' {Maybe [PermissionGroup]
permissionGroups :: Maybe [PermissionGroup]
$sel:permissionGroups:ListPermissionGroupsResponse' :: ListPermissionGroupsResponse -> Maybe [PermissionGroup]
permissionGroups} -> Maybe [PermissionGroup]
permissionGroups) (\s :: ListPermissionGroupsResponse
s@ListPermissionGroupsResponse' {} Maybe [PermissionGroup]
a -> ListPermissionGroupsResponse
s {$sel:permissionGroups:ListPermissionGroupsResponse' :: Maybe [PermissionGroup]
permissionGroups = Maybe [PermissionGroup]
a} :: ListPermissionGroupsResponse) 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 response's http status code.
listPermissionGroupsResponse_httpStatus :: Lens.Lens' ListPermissionGroupsResponse Prelude.Int
listPermissionGroupsResponse_httpStatus :: Lens' ListPermissionGroupsResponse Int
listPermissionGroupsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListPermissionGroupsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListPermissionGroupsResponse' :: ListPermissionGroupsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListPermissionGroupsResponse
s@ListPermissionGroupsResponse' {} Int
a -> ListPermissionGroupsResponse
s {$sel:httpStatus:ListPermissionGroupsResponse' :: Int
httpStatus = Int
a} :: ListPermissionGroupsResponse)

instance Prelude.NFData ListPermissionGroupsResponse where
  rnf :: ListPermissionGroupsResponse -> ()
rnf ListPermissionGroupsResponse' {Int
Maybe [PermissionGroup]
Maybe Text
httpStatus :: Int
permissionGroups :: Maybe [PermissionGroup]
nextToken :: Maybe Text
$sel:httpStatus:ListPermissionGroupsResponse' :: ListPermissionGroupsResponse -> Int
$sel:permissionGroups:ListPermissionGroupsResponse' :: ListPermissionGroupsResponse -> Maybe [PermissionGroup]
$sel:nextToken:ListPermissionGroupsResponse' :: ListPermissionGroupsResponse -> 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 Maybe [PermissionGroup]
permissionGroups
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus