amazonka-guardduty-2.0: gen/Amazonka/GuardDuty/GetMembers.hs
{-# 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.GuardDuty.GetMembers
-- 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 GuardDuty member accounts (of the current GuardDuty
-- administrator account) specified by the account IDs.
module Amazonka.GuardDuty.GetMembers
( -- * Creating a Request
GetMembers (..),
newGetMembers,
-- * Request Lenses
getMembers_detectorId,
getMembers_accountIds,
-- * Destructuring the Response
GetMembersResponse (..),
newGetMembersResponse,
-- * Response Lenses
getMembersResponse_httpStatus,
getMembersResponse_members,
getMembersResponse_unprocessedAccounts,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.GuardDuty.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- | /See:/ 'newGetMembers' smart constructor.
data GetMembers = GetMembers'
{ -- | The unique ID of the detector of the GuardDuty account whose members you
-- want to retrieve.
detectorId :: Prelude.Text,
-- | A list of account IDs of the GuardDuty member accounts that you want to
-- describe.
accountIds :: Prelude.NonEmpty Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'GetMembers' 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:
--
-- 'detectorId', 'getMembers_detectorId' - The unique ID of the detector of the GuardDuty account whose members you
-- want to retrieve.
--
-- 'accountIds', 'getMembers_accountIds' - A list of account IDs of the GuardDuty member accounts that you want to
-- describe.
newGetMembers ::
-- | 'detectorId'
Prelude.Text ->
-- | 'accountIds'
Prelude.NonEmpty Prelude.Text ->
GetMembers
newGetMembers pDetectorId_ pAccountIds_ =
GetMembers'
{ detectorId = pDetectorId_,
accountIds = Lens.coerced Lens.# pAccountIds_
}
-- | The unique ID of the detector of the GuardDuty account whose members you
-- want to retrieve.
getMembers_detectorId :: Lens.Lens' GetMembers Prelude.Text
getMembers_detectorId = Lens.lens (\GetMembers' {detectorId} -> detectorId) (\s@GetMembers' {} a -> s {detectorId = a} :: GetMembers)
-- | A list of account IDs of the GuardDuty member accounts that you want to
-- describe.
getMembers_accountIds :: Lens.Lens' GetMembers (Prelude.NonEmpty Prelude.Text)
getMembers_accountIds = Lens.lens (\GetMembers' {accountIds} -> accountIds) (\s@GetMembers' {} a -> s {accountIds = a} :: GetMembers) Prelude.. Lens.coerced
instance Core.AWSRequest GetMembers where
type AWSResponse GetMembers = GetMembersResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
GetMembersResponse'
Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
Prelude.<*> (x Data..?> "members" Core..!@ Prelude.mempty)
Prelude.<*> ( x
Data..?> "unprocessedAccounts"
Core..!@ Prelude.mempty
)
)
instance Prelude.Hashable GetMembers where
hashWithSalt _salt GetMembers' {..} =
_salt
`Prelude.hashWithSalt` detectorId
`Prelude.hashWithSalt` accountIds
instance Prelude.NFData GetMembers where
rnf GetMembers' {..} =
Prelude.rnf detectorId
`Prelude.seq` Prelude.rnf accountIds
instance Data.ToHeaders GetMembers where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON GetMembers where
toJSON GetMembers' {..} =
Data.object
( Prelude.catMaybes
[Prelude.Just ("accountIds" Data..= accountIds)]
)
instance Data.ToPath GetMembers where
toPath GetMembers' {..} =
Prelude.mconcat
["/detector/", Data.toBS detectorId, "/member/get"]
instance Data.ToQuery GetMembers where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newGetMembersResponse' smart constructor.
data GetMembersResponse = GetMembersResponse'
{ -- | The response's http status code.
httpStatus :: Prelude.Int,
-- | A list of members.
members :: [Member],
-- | A list of objects that contain the unprocessed account and a result
-- string that explains why it was unprocessed.
unprocessedAccounts :: [UnprocessedAccount]
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'GetMembersResponse' 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:
--
-- 'httpStatus', 'getMembersResponse_httpStatus' - The response's http status code.
--
-- 'members', 'getMembersResponse_members' - A list of members.
--
-- 'unprocessedAccounts', 'getMembersResponse_unprocessedAccounts' - A list of objects that contain the unprocessed account and a result
-- string that explains why it was unprocessed.
newGetMembersResponse ::
-- | 'httpStatus'
Prelude.Int ->
GetMembersResponse
newGetMembersResponse pHttpStatus_ =
GetMembersResponse'
{ httpStatus = pHttpStatus_,
members = Prelude.mempty,
unprocessedAccounts = Prelude.mempty
}
-- | The response's http status code.
getMembersResponse_httpStatus :: Lens.Lens' GetMembersResponse Prelude.Int
getMembersResponse_httpStatus = Lens.lens (\GetMembersResponse' {httpStatus} -> httpStatus) (\s@GetMembersResponse' {} a -> s {httpStatus = a} :: GetMembersResponse)
-- | A list of members.
getMembersResponse_members :: Lens.Lens' GetMembersResponse [Member]
getMembersResponse_members = Lens.lens (\GetMembersResponse' {members} -> members) (\s@GetMembersResponse' {} a -> s {members = a} :: GetMembersResponse) Prelude.. Lens.coerced
-- | A list of objects that contain the unprocessed account and a result
-- string that explains why it was unprocessed.
getMembersResponse_unprocessedAccounts :: Lens.Lens' GetMembersResponse [UnprocessedAccount]
getMembersResponse_unprocessedAccounts = Lens.lens (\GetMembersResponse' {unprocessedAccounts} -> unprocessedAccounts) (\s@GetMembersResponse' {} a -> s {unprocessedAccounts = a} :: GetMembersResponse) Prelude.. Lens.coerced
instance Prelude.NFData GetMembersResponse where
rnf GetMembersResponse' {..} =
Prelude.rnf httpStatus
`Prelude.seq` Prelude.rnf members
`Prelude.seq` Prelude.rnf unprocessedAccounts