amazonka-guardduty-2.0: Amazon GuardDuty SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GuardDuty.InviteMembers

Description

Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account.

Synopsis

Creating a Request

data InviteMembers Source #

See: newInviteMembers smart constructor.

Constructors

InviteMembers' 

Fields

  • disableEmailNotification :: Maybe Bool

    A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

  • message :: Maybe Text

    The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

  • detectorId :: Text

    The unique ID of the detector of the GuardDuty account that you want to invite members with.

  • accountIds :: NonEmpty Text

    A list of account IDs of the accounts that you want to invite to GuardDuty as members.

Instances

Instances details
ToJSON InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

toJSON :: InviteMembers -> Value #

toEncoding :: InviteMembers -> Encoding #

toJSONList :: [InviteMembers] -> Value #

toEncodingList :: [InviteMembers] -> Encoding #

ToHeaders InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

toHeaders :: InviteMembers -> [Header] #

ToPath InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

toPath :: InviteMembers -> ByteString #

ToQuery InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

toQuery :: InviteMembers -> QueryString #

AWSRequest InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Associated Types

type AWSResponse InviteMembers #

Methods

request :: (Service -> Service) -> InviteMembers -> Request InviteMembers #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy InviteMembers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InviteMembers))) #

Generic InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Associated Types

type Rep InviteMembers :: Type -> Type #

Methods

from :: InviteMembers -> Rep InviteMembers x #

to :: Rep InviteMembers x -> InviteMembers #

Read InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

readsPrec :: Int -> ReadS InviteMembers #

readList :: ReadS [InviteMembers] #

readPrec :: ReadPrec InviteMembers #

readListPrec :: ReadPrec [InviteMembers] #

Show InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

showsPrec :: Int -> InviteMembers -> ShowS #

show :: InviteMembers -> String #

showList :: [InviteMembers] -> ShowS #

NFData InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

rnf :: InviteMembers -> () #

Eq InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

(==) :: InviteMembers -> InviteMembers -> Bool #

(/=) :: InviteMembers -> InviteMembers -> Bool #

Hashable InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

hashWithSalt :: Int -> InviteMembers -> Int #

hash :: InviteMembers -> Int #

type AWSResponse InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

type AWSResponse InviteMembers = InviteMembersResponse
type Rep InviteMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

type Rep InviteMembers = D1 ('MetaData "InviteMembers" "Amazonka.GuardDuty.InviteMembers" "amazonka-guardduty-2.0-2NN502sGcQRH5risQZb24c" 'False) (C1 ('MetaCons "InviteMembers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disableEmailNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))

newInviteMembers Source #

Arguments

:: Text

InviteMembers

-> NonEmpty Text

InviteMembers

-> InviteMembers 

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:disableEmailNotification:InviteMembers', inviteMembers_disableEmailNotification - A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

$sel:message:InviteMembers', inviteMembers_message - The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

InviteMembers, inviteMembers_detectorId - The unique ID of the detector of the GuardDuty account that you want to invite members with.

InviteMembers, inviteMembers_accountIds - A list of account IDs of the accounts that you want to invite to GuardDuty as members.

Request Lenses

inviteMembers_disableEmailNotification :: Lens' InviteMembers (Maybe Bool) Source #

A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

inviteMembers_message :: Lens' InviteMembers (Maybe Text) Source #

The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

inviteMembers_detectorId :: Lens' InviteMembers Text Source #

The unique ID of the detector of the GuardDuty account that you want to invite members with.

inviteMembers_accountIds :: Lens' InviteMembers (NonEmpty Text) Source #

A list of account IDs of the accounts that you want to invite to GuardDuty as members.

Destructuring the Response

data InviteMembersResponse Source #

See: newInviteMembersResponse smart constructor.

Constructors

InviteMembersResponse' 

Fields

Instances

Instances details
Generic InviteMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Associated Types

type Rep InviteMembersResponse :: Type -> Type #

Methods

from :: InviteMembersResponse -> Rep InviteMembersResponse x #

to :: Rep InviteMembersResponse x -> InviteMembersResponse #

Read InviteMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

readsPrec :: Int -> ReadS InviteMembersResponse #

readList :: ReadS [InviteMembersResponse] #

readPrec :: ReadPrec InviteMembersResponse #

readListPrec :: ReadPrec [InviteMembersResponse] #

Show InviteMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

showsPrec :: Int -> InviteMembersResponse -> ShowS #

show :: InviteMembersResponse -> String #

showList :: [InviteMembersResponse] -> ShowS #

NFData InviteMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

rnf :: InviteMembersResponse -> () #

Eq InviteMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

Methods

(==) :: InviteMembersResponse -> InviteMembersResponse -> Bool #

(/=) :: InviteMembersResponse -> InviteMembersResponse -> Bool #

type Rep InviteMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.InviteMembers

type Rep InviteMembersResponse = D1 ('MetaData "InviteMembersResponse" "Amazonka.GuardDuty.InviteMembers" "amazonka-guardduty-2.0-2NN502sGcQRH5risQZb24c" 'False) (C1 ('MetaCons "InviteMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [UnprocessedAccount])))

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:httpStatus:InviteMembersResponse', inviteMembersResponse_httpStatus - The response's http status code.

$sel:unprocessedAccounts:InviteMembersResponse', inviteMembersResponse_unprocessedAccounts - A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

Response Lenses

inviteMembersResponse_httpStatus :: Lens' InviteMembersResponse Int Source #

The response's http status code.

inviteMembersResponse_unprocessedAccounts :: Lens' InviteMembersResponse [UnprocessedAccount] Source #

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.