{-# 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.Detective.ListMembers
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves the list of member accounts for a behavior graph.
--
-- For invited accounts, the results do not include member accounts that
-- were removed from the behavior graph.
--
-- For the organization behavior graph, the results do not include
-- organization accounts that the Detective administrator account has not
-- enabled as member accounts.
module Amazonka.Detective.ListMembers
  ( -- * Creating a Request
    ListMembers (..),
    newListMembers,

    -- * Request Lenses
    listMembers_maxResults,
    listMembers_nextToken,
    listMembers_graphArn,

    -- * Destructuring the Response
    ListMembersResponse (..),
    newListMembersResponse,

    -- * Response Lenses
    listMembersResponse_memberDetails,
    listMembersResponse_nextToken,
    listMembersResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListMembers' smart constructor.
data ListMembers = ListMembers'
  { -- | The maximum number of member accounts to include in the response. The
    -- total must be less than the overall limit on the number of results to
    -- return, which is currently 200.
    ListMembers -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | For requests to retrieve the next page of member account results, the
    -- pagination token that was returned with the previous page of results.
    -- The initial request does not include a pagination token.
    ListMembers -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The ARN of the behavior graph for which to retrieve the list of member
    -- accounts.
    ListMembers -> Text
graphArn :: Prelude.Text
  }
  deriving (ListMembers -> ListMembers -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListMembers -> ListMembers -> Bool
$c/= :: ListMembers -> ListMembers -> Bool
== :: ListMembers -> ListMembers -> Bool
$c== :: ListMembers -> ListMembers -> Bool
Prelude.Eq, ReadPrec [ListMembers]
ReadPrec ListMembers
Int -> ReadS ListMembers
ReadS [ListMembers]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListMembers]
$creadListPrec :: ReadPrec [ListMembers]
readPrec :: ReadPrec ListMembers
$creadPrec :: ReadPrec ListMembers
readList :: ReadS [ListMembers]
$creadList :: ReadS [ListMembers]
readsPrec :: Int -> ReadS ListMembers
$creadsPrec :: Int -> ReadS ListMembers
Prelude.Read, Int -> ListMembers -> ShowS
[ListMembers] -> ShowS
ListMembers -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListMembers] -> ShowS
$cshowList :: [ListMembers] -> ShowS
show :: ListMembers -> String
$cshow :: ListMembers -> String
showsPrec :: Int -> ListMembers -> ShowS
$cshowsPrec :: Int -> ListMembers -> ShowS
Prelude.Show, forall x. Rep ListMembers x -> ListMembers
forall x. ListMembers -> Rep ListMembers x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListMembers x -> ListMembers
$cfrom :: forall x. ListMembers -> Rep ListMembers x
Prelude.Generic)

-- |
-- Create a value of 'ListMembers' 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', 'listMembers_maxResults' - The maximum number of member accounts to include in the response. The
-- total must be less than the overall limit on the number of results to
-- return, which is currently 200.
--
-- 'nextToken', 'listMembers_nextToken' - For requests to retrieve the next page of member account results, the
-- pagination token that was returned with the previous page of results.
-- The initial request does not include a pagination token.
--
-- 'graphArn', 'listMembers_graphArn' - The ARN of the behavior graph for which to retrieve the list of member
-- accounts.
newListMembers ::
  -- | 'graphArn'
  Prelude.Text ->
  ListMembers
newListMembers :: Text -> ListMembers
newListMembers Text
pGraphArn_ =
  ListMembers'
    { $sel:maxResults:ListMembers' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListMembers' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:graphArn:ListMembers' :: Text
graphArn = Text
pGraphArn_
    }

-- | The maximum number of member accounts to include in the response. The
-- total must be less than the overall limit on the number of results to
-- return, which is currently 200.
listMembers_maxResults :: Lens.Lens' ListMembers (Prelude.Maybe Prelude.Natural)
listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
listMembers_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMembers' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListMembers' :: ListMembers -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListMembers
s@ListMembers' {} Maybe Natural
a -> ListMembers
s {$sel:maxResults:ListMembers' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListMembers)

-- | For requests to retrieve the next page of member account results, the
-- pagination token that was returned with the previous page of results.
-- The initial request does not include a pagination token.
listMembers_nextToken :: Lens.Lens' ListMembers (Prelude.Maybe Prelude.Text)
listMembers_nextToken :: Lens' ListMembers (Maybe Text)
listMembers_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMembers' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListMembers' :: ListMembers -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListMembers
s@ListMembers' {} Maybe Text
a -> ListMembers
s {$sel:nextToken:ListMembers' :: Maybe Text
nextToken = Maybe Text
a} :: ListMembers)

-- | The ARN of the behavior graph for which to retrieve the list of member
-- accounts.
listMembers_graphArn :: Lens.Lens' ListMembers Prelude.Text
listMembers_graphArn :: Lens' ListMembers Text
listMembers_graphArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMembers' {Text
graphArn :: Text
$sel:graphArn:ListMembers' :: ListMembers -> Text
graphArn} -> Text
graphArn) (\s :: ListMembers
s@ListMembers' {} Text
a -> ListMembers
s {$sel:graphArn:ListMembers' :: Text
graphArn = Text
a} :: ListMembers)

instance Core.AWSRequest ListMembers where
  type AWSResponse ListMembers = ListMembersResponse
  request :: (Service -> Service) -> ListMembers -> Request ListMembers
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 ListMembers
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListMembers)))
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 [MemberDetail] -> Maybe Text -> Int -> ListMembersResponse
ListMembersResponse'
            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
"MemberDetails" 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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

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

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

instance Data.ToHeaders ListMembers where
  toHeaders :: ListMembers -> 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.ToJSON ListMembers where
  toJSON :: ListMembers -> Value
toJSON ListMembers' {Maybe Natural
Maybe Text
Text
graphArn :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:graphArn:ListMembers' :: ListMembers -> Text
$sel:nextToken:ListMembers' :: ListMembers -> Maybe Text
$sel:maxResults:ListMembers' :: ListMembers -> 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,
            forall a. a -> Maybe a
Prelude.Just (Key
"GraphArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
graphArn)
          ]
      )

instance Data.ToPath ListMembers where
  toPath :: ListMembers -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/graph/members/list"

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

-- | /See:/ 'newListMembersResponse' smart constructor.
data ListMembersResponse = ListMembersResponse'
  { -- | The list of member accounts in the behavior graph.
    --
    -- For invited accounts, the results include member accounts that did not
    -- pass verification and member accounts that have not yet accepted the
    -- invitation to the behavior graph. The results do not include member
    -- accounts that were removed from the behavior graph.
    --
    -- For the organization behavior graph, the results do not include
    -- organization accounts that the Detective administrator account has not
    -- enabled as member accounts.
    ListMembersResponse -> Maybe [MemberDetail]
memberDetails :: Prelude.Maybe [MemberDetail],
    -- | If there are more member accounts remaining in the results, then use
    -- this pagination token to request the next page of member accounts.
    ListMembersResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListMembersResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListMembersResponse -> ListMembersResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListMembersResponse -> ListMembersResponse -> Bool
$c/= :: ListMembersResponse -> ListMembersResponse -> Bool
== :: ListMembersResponse -> ListMembersResponse -> Bool
$c== :: ListMembersResponse -> ListMembersResponse -> Bool
Prelude.Eq, ReadPrec [ListMembersResponse]
ReadPrec ListMembersResponse
Int -> ReadS ListMembersResponse
ReadS [ListMembersResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListMembersResponse]
$creadListPrec :: ReadPrec [ListMembersResponse]
readPrec :: ReadPrec ListMembersResponse
$creadPrec :: ReadPrec ListMembersResponse
readList :: ReadS [ListMembersResponse]
$creadList :: ReadS [ListMembersResponse]
readsPrec :: Int -> ReadS ListMembersResponse
$creadsPrec :: Int -> ReadS ListMembersResponse
Prelude.Read, Int -> ListMembersResponse -> ShowS
[ListMembersResponse] -> ShowS
ListMembersResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListMembersResponse] -> ShowS
$cshowList :: [ListMembersResponse] -> ShowS
show :: ListMembersResponse -> String
$cshow :: ListMembersResponse -> String
showsPrec :: Int -> ListMembersResponse -> ShowS
$cshowsPrec :: Int -> ListMembersResponse -> ShowS
Prelude.Show, forall x. Rep ListMembersResponse x -> ListMembersResponse
forall x. ListMembersResponse -> Rep ListMembersResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListMembersResponse x -> ListMembersResponse
$cfrom :: forall x. ListMembersResponse -> Rep ListMembersResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListMembersResponse' 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:
--
-- 'memberDetails', 'listMembersResponse_memberDetails' - The list of member accounts in the behavior graph.
--
-- For invited accounts, the results include member accounts that did not
-- pass verification and member accounts that have not yet accepted the
-- invitation to the behavior graph. The results do not include member
-- accounts that were removed from the behavior graph.
--
-- For the organization behavior graph, the results do not include
-- organization accounts that the Detective administrator account has not
-- enabled as member accounts.
--
-- 'nextToken', 'listMembersResponse_nextToken' - If there are more member accounts remaining in the results, then use
-- this pagination token to request the next page of member accounts.
--
-- 'httpStatus', 'listMembersResponse_httpStatus' - The response's http status code.
newListMembersResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListMembersResponse
newListMembersResponse :: Int -> ListMembersResponse
newListMembersResponse Int
pHttpStatus_ =
  ListMembersResponse'
    { $sel:memberDetails:ListMembersResponse' :: Maybe [MemberDetail]
memberDetails =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListMembersResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListMembersResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The list of member accounts in the behavior graph.
--
-- For invited accounts, the results include member accounts that did not
-- pass verification and member accounts that have not yet accepted the
-- invitation to the behavior graph. The results do not include member
-- accounts that were removed from the behavior graph.
--
-- For the organization behavior graph, the results do not include
-- organization accounts that the Detective administrator account has not
-- enabled as member accounts.
listMembersResponse_memberDetails :: Lens.Lens' ListMembersResponse (Prelude.Maybe [MemberDetail])
listMembersResponse_memberDetails :: Lens' ListMembersResponse (Maybe [MemberDetail])
listMembersResponse_memberDetails = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMembersResponse' {Maybe [MemberDetail]
memberDetails :: Maybe [MemberDetail]
$sel:memberDetails:ListMembersResponse' :: ListMembersResponse -> Maybe [MemberDetail]
memberDetails} -> Maybe [MemberDetail]
memberDetails) (\s :: ListMembersResponse
s@ListMembersResponse' {} Maybe [MemberDetail]
a -> ListMembersResponse
s {$sel:memberDetails:ListMembersResponse' :: Maybe [MemberDetail]
memberDetails = Maybe [MemberDetail]
a} :: ListMembersResponse) 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

-- | If there are more member accounts remaining in the results, then use
-- this pagination token to request the next page of member accounts.
listMembersResponse_nextToken :: Lens.Lens' ListMembersResponse (Prelude.Maybe Prelude.Text)
listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text)
listMembersResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListMembersResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListMembersResponse' :: ListMembersResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListMembersResponse
s@ListMembersResponse' {} Maybe Text
a -> ListMembersResponse
s {$sel:nextToken:ListMembersResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListMembersResponse)

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

instance Prelude.NFData ListMembersResponse where
  rnf :: ListMembersResponse -> ()
rnf ListMembersResponse' {Int
Maybe [MemberDetail]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
memberDetails :: Maybe [MemberDetail]
$sel:httpStatus:ListMembersResponse' :: ListMembersResponse -> Int
$sel:nextToken:ListMembersResponse' :: ListMembersResponse -> Maybe Text
$sel:memberDetails:ListMembersResponse' :: ListMembersResponse -> Maybe [MemberDetail]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [MemberDetail]
memberDetails
      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 Int
httpStatus