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.InviteMembers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.

This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.

Creating a Request

data InviteMembers Source #

See: newInviteMembers smart constructor.

Constructors

InviteMembers'
Fields accountIds :: [Text] The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.

Instances

Instances details

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

newInviteMembers :: InviteMembers Source #

Create a value of InviteMembers 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:InviteMembers', inviteMembers_accountIds - The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.

Request Lenses

inviteMembers_accountIds :: Lens' InviteMembers [Text] Source #

The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.

Destructuring the Response

data InviteMembersResponse Source #

See: newInviteMembersResponse smart constructor.

Constructors

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

newInviteMembersResponse Source #

Arguments

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

Create a value of InviteMembersResponse 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:unprocessedAccounts:InviteMembersResponse', inviteMembersResponse_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:InviteMembersResponse', inviteMembersResponse_httpStatus - The response's http status code.

Response Lenses

inviteMembersResponse_unprocessedAccounts :: Lens' InviteMembersResponse (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.

inviteMembersResponse_httpStatus :: Lens' InviteMembersResponse Int Source #

The response's http status code.