Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecurityHub.GetMembers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the details for the Security Hub member accounts for the specified account IDs.

An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.

The results include both member accounts that are managed using Organizations and accounts that were invited manually.

Synopsis

data GetMembers = GetMembers' {
- accountIds :: [Text]
}
newGetMembers :: GetMembers
getMembers_accountIds :: Lens' GetMembers [Text]
data GetMembersResponse = GetMembersResponse' {
- members :: Maybe [Member]
- unprocessedAccounts :: Maybe [Result]
- httpStatus :: Int
}
newGetMembersResponse :: Int -> GetMembersResponse
getMembersResponse_members :: Lens' GetMembersResponse (Maybe [Member])
getMembersResponse_unprocessedAccounts :: Lens' GetMembersResponse (Maybe [Result])
getMembersResponse_httpStatus :: Lens' GetMembersResponse Int

Creating a Request

data GetMembers Source #

See: newGetMembers smart constructor.

Constructors

GetMembers'
Fields accountIds :: [Text] The list of account IDs for the Security Hub member accounts to return the details for.

Instances

Instances details

Eq GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods (==) :: GetMembers -> GetMembers -> Bool # (/=) :: GetMembers -> GetMembers -> Bool #
Read GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods readsPrec :: Int -> ReadS GetMembers # readList :: ReadS [GetMembers] # readPrec :: ReadPrec GetMembers # readListPrec :: ReadPrec [GetMembers] #
Show GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods showsPrec :: Int -> GetMembers -> ShowS # show :: GetMembers -> String # showList :: [GetMembers] -> ShowS #
Generic GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Associated Types type Rep GetMembers :: Type -> Type # Methods from :: GetMembers -> Rep GetMembers x # to :: Rep GetMembers x -> GetMembers #
NFData GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods rnf :: GetMembers -> () #
Hashable GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods hashWithSalt :: Int -> GetMembers -> Int # hash :: GetMembers -> Int #
ToJSON GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods toJSON :: GetMembers -> Value # toEncoding :: GetMembers -> Encoding # toJSONList :: [GetMembers] -> Value # toEncodingList :: [GetMembers] -> Encoding #
AWSRequest GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Associated Types type AWSResponse GetMembers # Methods request :: GetMembers -> Request GetMembers # response :: MonadResource m => Logger -> Service -> Proxy GetMembers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMembers))) #
ToHeaders GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods toHeaders :: GetMembers -> [Header] #
ToPath GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods toPath :: GetMembers -> ByteString #
ToQuery GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods toQuery :: GetMembers -> QueryString #
type Rep GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers type Rep GetMembers = D1 ('MetaData "GetMembers" "Amazonka.SecurityHub.GetMembers" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "GetMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))
type AWSResponse GetMembers Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers type AWSResponse GetMembers = GetMembersResponse

newGetMembers :: GetMembers Source #

Create a value of GetMembers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountIds:GetMembers', getMembers_accountIds - The list of account IDs for the Security Hub member accounts to return the details for.

Request Lenses

getMembers_accountIds :: Lens' GetMembers [Text] Source #

The list of account IDs for the Security Hub member accounts to return the details for.

Destructuring the Response

data GetMembersResponse Source #

See: newGetMembersResponse smart constructor.

Constructors

GetMembersResponse'
Fields members :: Maybe [Member] The list of details about the Security Hub member accounts. unprocessedAccounts :: Maybe [Result] The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetMembersResponse Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods (==) :: GetMembersResponse -> GetMembersResponse -> Bool # (/=) :: GetMembersResponse -> GetMembersResponse -> Bool #
Read GetMembersResponse Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods readsPrec :: Int -> ReadS GetMembersResponse # readList :: ReadS [GetMembersResponse] # readPrec :: ReadPrec GetMembersResponse # readListPrec :: ReadPrec [GetMembersResponse] #
Show GetMembersResponse Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods showsPrec :: Int -> GetMembersResponse -> ShowS # show :: GetMembersResponse -> String # showList :: [GetMembersResponse] -> ShowS #
Generic GetMembersResponse Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Associated Types type Rep GetMembersResponse :: Type -> Type # Methods from :: GetMembersResponse -> Rep GetMembersResponse x # to :: Rep GetMembersResponse x -> GetMembersResponse #
NFData GetMembersResponse Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers Methods rnf :: GetMembersResponse -> () #
type Rep GetMembersResponse Source #
Instance details Defined in Amazonka.SecurityHub.GetMembers type Rep GetMembersResponse = D1 ('MetaData "GetMembersResponse" "Amazonka.SecurityHub.GetMembers" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "GetMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "members") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Member])) :: (S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Result])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetMembersResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetMembersResponse'`
-> GetMembersResponse

Create a value of GetMembersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:members:GetMembersResponse', getMembersResponse_members - The list of details about the Security Hub member accounts.

$sel:unprocessedAccounts:GetMembersResponse', getMembersResponse_unprocessedAccounts - The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.

$sel:httpStatus:GetMembersResponse', getMembersResponse_httpStatus - The response's http status code.

Response Lenses

getMembersResponse_members :: Lens' GetMembersResponse (Maybe [Member]) Source #

The list of details about the Security Hub member accounts.

getMembersResponse_unprocessedAccounts :: Lens' GetMembersResponse (Maybe [Result]) Source #

The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.

getMembersResponse_httpStatus :: Lens' GetMembersResponse Int Source #

The response's http status code.