libZSservicesZSamazonka-detectiveZSamazonka-detective
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.Detective.CreateMembers

Description

Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.

CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.

The request provides the behavior graph ARN and the list of accounts to invite.

The response separates the requested accounts into two lists:

  • The accounts that CreateMembers was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification.
  • The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.
Synopsis

Creating a Request

data CreateMembers Source #

See: newCreateMembers smart constructor.

Constructors

CreateMembers' 

Fields

  • disableEmailNotification :: Maybe Bool

    if set to true, then the member accounts do not receive email notifications. By default, this is set to false, and the member accounts receive email notifications.

  • message :: Maybe Text

    Customized message text to include in the invitation email message to the invited member accounts.

  • graphArn :: Text

    The ARN of the behavior graph to invite the member accounts to contribute their data to.

  • accounts :: NonEmpty Account

    The list of AWS accounts to invite to become member accounts in the behavior graph. You can invite up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the AWS account root user email address.

Instances

Instances details
Eq CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

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

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

Read CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

readsPrec :: Int -> ReadS CreateMembers #

readList :: ReadS [CreateMembers] #

readPrec :: ReadPrec CreateMembers #

readListPrec :: ReadPrec [CreateMembers] #

Show CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

showsPrec :: Int -> CreateMembers -> ShowS #

show :: CreateMembers -> String #

showList :: [CreateMembers] -> ShowS #

Generic CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Associated Types

type Rep CreateMembers :: Type -> Type #

Methods

from :: CreateMembers -> Rep CreateMembers x #

to :: Rep CreateMembers x -> CreateMembers #

NFData CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

rnf :: CreateMembers -> () #

Hashable CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

hashWithSalt :: Int -> CreateMembers -> Int #

hash :: CreateMembers -> Int #

ToJSON CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

toJSON :: CreateMembers -> Value #

toEncoding :: CreateMembers -> Encoding #

toJSONList :: [CreateMembers] -> Value #

toEncodingList :: [CreateMembers] -> Encoding #

AWSRequest CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Associated Types

type AWSResponse CreateMembers #

Methods

request :: CreateMembers -> Request CreateMembers #

response :: MonadResource m => Logger -> Service -> Proxy CreateMembers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateMembers))) #

ToHeaders CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

toHeaders :: CreateMembers -> [Header] #

ToPath CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

toPath :: CreateMembers -> ByteString #

ToQuery CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

toQuery :: CreateMembers -> QueryString #

type Rep CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

type Rep CreateMembers = D1 ('MetaData "CreateMembers" "Amazonka.Detective.CreateMembers" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "CreateMembers'" '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 "graphArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Account)))))
type AWSResponse CreateMembers Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

type AWSResponse CreateMembers = CreateMembersResponse

newCreateMembers Source #

Arguments

:: Text

$sel:graphArn:CreateMembers'

-> NonEmpty Account

$sel:accounts:CreateMembers'

-> CreateMembers 

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:disableEmailNotification:CreateMembers', createMembers_disableEmailNotification - if set to true, then the member accounts do not receive email notifications. By default, this is set to false, and the member accounts receive email notifications.

$sel:message:CreateMembers', createMembers_message - Customized message text to include in the invitation email message to the invited member accounts.

$sel:graphArn:CreateMembers', createMembers_graphArn - The ARN of the behavior graph to invite the member accounts to contribute their data to.

$sel:accounts:CreateMembers', createMembers_accounts - The list of AWS accounts to invite to become member accounts in the behavior graph. You can invite up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the AWS account root user email address.

Request Lenses

createMembers_disableEmailNotification :: Lens' CreateMembers (Maybe Bool) Source #

if set to true, then the member accounts do not receive email notifications. By default, this is set to false, and the member accounts receive email notifications.

createMembers_message :: Lens' CreateMembers (Maybe Text) Source #

Customized message text to include in the invitation email message to the invited member accounts.

createMembers_graphArn :: Lens' CreateMembers Text Source #

The ARN of the behavior graph to invite the member accounts to contribute their data to.

createMembers_accounts :: Lens' CreateMembers (NonEmpty Account) Source #

The list of AWS accounts to invite to become member accounts in the behavior graph. You can invite up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the AWS account root user email address.

Destructuring the Response

data CreateMembersResponse Source #

See: newCreateMembersResponse smart constructor.

Constructors

CreateMembersResponse' 

Fields

  • members :: Maybe [MemberDetail]

    The set of member account invitation requests that Detective was able to process. This includes accounts that are being verified, that failed verification, and that passed verification and are being sent an invitation.

  • unprocessedAccounts :: Maybe [UnprocessedAccount]

    The list of accounts for which Detective was unable to process the invitation request. For each account, the list provides the reason why the request could not be processed. The list includes accounts that are already member accounts in the behavior graph.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

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

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

Read CreateMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

readsPrec :: Int -> ReadS CreateMembersResponse #

readList :: ReadS [CreateMembersResponse] #

readPrec :: ReadPrec CreateMembersResponse #

readListPrec :: ReadPrec [CreateMembersResponse] #

Show CreateMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

showsPrec :: Int -> CreateMembersResponse -> ShowS #

show :: CreateMembersResponse -> String #

showList :: [CreateMembersResponse] -> ShowS #

Generic CreateMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Associated Types

type Rep CreateMembersResponse :: Type -> Type #

Methods

from :: CreateMembersResponse -> Rep CreateMembersResponse x #

to :: Rep CreateMembersResponse x -> CreateMembersResponse #

NFData CreateMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

Methods

rnf :: CreateMembersResponse -> () #

type Rep CreateMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.CreateMembers

type Rep CreateMembersResponse = D1 ('MetaData "CreateMembersResponse" "Amazonka.Detective.CreateMembers" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "CreateMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "members") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MemberDetail])) :*: (S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UnprocessedAccount])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateMembersResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateMembersResponse'

-> CreateMembersResponse 

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:members:CreateMembersResponse', createMembersResponse_members - The set of member account invitation requests that Detective was able to process. This includes accounts that are being verified, that failed verification, and that passed verification and are being sent an invitation.

$sel:unprocessedAccounts:CreateMembersResponse', createMembersResponse_unprocessedAccounts - The list of accounts for which Detective was unable to process the invitation request. For each account, the list provides the reason why the request could not be processed. The list includes accounts that are already member accounts in the behavior graph.

$sel:httpStatus:CreateMembersResponse', createMembersResponse_httpStatus - The response's http status code.

Response Lenses

createMembersResponse_members :: Lens' CreateMembersResponse (Maybe [MemberDetail]) Source #

The set of member account invitation requests that Detective was able to process. This includes accounts that are being verified, that failed verification, and that passed verification and are being sent an invitation.

createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse (Maybe [UnprocessedAccount]) Source #

The list of accounts for which Detective was unable to process the invitation request. For each account, the list provides the reason why the request could not be processed. The list includes accounts that are already member accounts in the behavior graph.

createMembersResponse_httpStatus :: Lens' CreateMembersResponse Int Source #

The response's http status code.