libZSservicesZSamazonka-guarddutyZSamazonka-guardduty
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GuardDuty.CreateMembers

Description

Creates member accounts of the current AWS account by specifying a list of AWS account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.

When using Create Members as an organizations delegated administrator this action will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account, which must enable GuardDuty prior to being added as a member.

If you are adding accounts by invitation use this action after GuardDuty has been enabled in potential member accounts and before using Invite Members .

Synopsis

Creating a Request

data CreateMembers Source #

See: newCreateMembers smart constructor.

Constructors

CreateMembers' 

Fields

  • detectorId :: Text

    The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

  • accountDetails :: NonEmpty AccountDetail

    A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.

Instances

Instances details
Eq CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Read CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Show CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Generic CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Associated Types

type Rep CreateMembers :: Type -> Type #

NFData CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Methods

rnf :: CreateMembers -> () #

Hashable CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

ToJSON CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

AWSRequest CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Associated Types

type AWSResponse CreateMembers #

ToHeaders CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

ToPath CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

ToQuery CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

type Rep CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

type Rep CreateMembers = D1 ('MetaData "CreateMembers" "Amazonka.GuardDuty.CreateMembers" "libZSservicesZSamazonka-guarddutyZSamazonka-guardduty" 'False) (C1 ('MetaCons "CreateMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accountDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty AccountDetail))))
type AWSResponse CreateMembers Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

newCreateMembers Source #

Create a value of CreateMembers 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:detectorId:CreateMembers', createMembers_detectorId - The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

$sel:accountDetails:CreateMembers', createMembers_accountDetails - A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.

Request Lenses

createMembers_detectorId :: Lens' CreateMembers Text Source #

The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

createMembers_accountDetails :: Lens' CreateMembers (NonEmpty AccountDetail) Source #

A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.

Destructuring the Response

data CreateMembersResponse Source #

See: newCreateMembersResponse smart constructor.

Constructors

CreateMembersResponse' 

Fields

Instances

Instances details
Eq CreateMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Read CreateMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Show CreateMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Generic CreateMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Associated Types

type Rep CreateMembersResponse :: Type -> Type #

NFData CreateMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

Methods

rnf :: CreateMembersResponse -> () #

type Rep CreateMembersResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.CreateMembers

type Rep CreateMembersResponse = D1 ('MetaData "CreateMembersResponse" "Amazonka.GuardDuty.CreateMembers" "libZSservicesZSamazonka-guarddutyZSamazonka-guardduty" 'False) (C1 ('MetaCons "CreateMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [UnprocessedAccount])))

newCreateMembersResponse Source #

Create a value of CreateMembersResponse 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:CreateMembersResponse', createMembersResponse_httpStatus - The response's http status code.

$sel:unprocessedAccounts:CreateMembersResponse', createMembersResponse_unprocessedAccounts - A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.

Response Lenses

createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse [UnprocessedAccount] Source #

A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.