Amazonka.Detective.CreateMembers

CreateMembers is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses CreateMembers to enable organization accounts as member accounts.

For invited accounts, CreateMembers sends a request to invite the specified Amazon Web Services 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.

For organization accounts in the organization behavior graph, CreateMembers attempts to enable the accounts. The organization accounts do not receive invitations.

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

The response separates the requested accounts into two lists:

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

Creating a Request

data CreateMembers

See: newCreateMembers smart constructor.

Constructors

CreateMembers'

Fields

• disableEmailNotification :: Maybe Bool

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

  Organization accounts in the organization behavior graph do not 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.

• accounts :: NonEmpty Account

  The list of Amazon Web Services accounts to invite or to enable. You can invite or enable up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the Amazon Web Services account root user email address. For organization accounts in the organization behavior graph, the email address is not required.

Instances

ToJSON CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

toJSON :: CreateMembers -> Value

toEncoding :: CreateMembers -> Encoding

toJSONList :: [CreateMembers] -> Value

toEncodingList :: [CreateMembers] -> Encoding

ToHeaders CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

toHeaders :: CreateMembers -> [Header]

ToPath CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

toPath :: CreateMembers -> ByteString

ToQuery CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

toQuery :: CreateMembers -> QueryString

AWSRequest CreateMembers

Defined in Amazonka.Detective.CreateMembers

Associated Types

type AWSResponse CreateMembers

Methods

request :: (Service -> Service) -> CreateMembers -> Request CreateMembers

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

Generic CreateMembers

Defined in Amazonka.Detective.CreateMembers

Associated Types

type Rep CreateMembers :: Type -> Type

Methods

from :: CreateMembers -> Rep CreateMembers x

to :: Rep CreateMembers x -> CreateMembers

Read CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

readsPrec :: Int -> ReadS CreateMembers

readList :: ReadS [CreateMembers]

readPrec :: ReadPrec CreateMembers

readListPrec :: ReadPrec [CreateMembers]

Show CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

showsPrec :: Int -> CreateMembers -> ShowS

show :: CreateMembers -> String

showList :: [CreateMembers] -> ShowS

NFData CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

rnf :: CreateMembers -> ()

Eq CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

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

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

Hashable CreateMembers

Defined in Amazonka.Detective.CreateMembers

Methods

hashWithSalt :: Int -> CreateMembers -> Int

hash :: CreateMembers -> Int

type AWSResponse CreateMembers

Defined in Amazonka.Detective.CreateMembers

type AWSResponse CreateMembers = CreateMembersResponse

type Rep CreateMembers

Defined in Amazonka.Detective.CreateMembers

type Rep CreateMembers = D1 ('MetaData "CreateMembers" "Amazonka.Detective.CreateMembers" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" '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)))))

newCreateMembers

Arguments

:: Text

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 invited accounts do not receive email notifications. By default, this is set to false, and the invited accounts receive email notifications.

Organization accounts in the organization behavior graph do not receive email notifications.

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

CreateMembers, createMembers_graphArn - The ARN of the behavior graph.

$sel:accounts:CreateMembers', createMembers_accounts - The list of Amazon Web Services accounts to invite or to enable. You can invite or enable up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the Amazon Web Services account root user email address. For organization accounts in the organization behavior graph, the email address is not required.

Request Lenses

createMembers_disableEmailNotification :: Lens' CreateMembers (Maybe Bool)

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

Organization accounts in the organization behavior graph do not receive email notifications.

createMembers_message :: Lens' CreateMembers (Maybe Text)

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

createMembers_graphArn :: Lens' CreateMembers Text

The ARN of the behavior graph.

createMembers_accounts :: Lens' CreateMembers (NonEmpty Account)

The list of Amazon Web Services accounts to invite or to enable. You can invite or enable up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the Amazon Web Services account root user email address. For organization accounts in the organization behavior graph, the email address is not required.

Destructuring the Response

data CreateMembersResponse

See: newCreateMembersResponse smart constructor.

Constructors

CreateMembersResponse'

Fields

• members :: Maybe [MemberDetail]

  The set of member account invitation or enablement 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 or are being enabled.

• unprocessedAccounts :: Maybe [UnprocessedAccount]

  The list of accounts for which Detective was unable to process the invitation or enablement 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

Generic CreateMembersResponse

Defined in Amazonka.Detective.CreateMembers

Associated Types

type Rep CreateMembersResponse :: Type -> Type

Methods

from :: CreateMembersResponse -> Rep CreateMembersResponse x

to :: Rep CreateMembersResponse x -> CreateMembersResponse

Read CreateMembersResponse

Defined in Amazonka.Detective.CreateMembers

Methods

readsPrec :: Int -> ReadS CreateMembersResponse

readList :: ReadS [CreateMembersResponse]

readPrec :: ReadPrec CreateMembersResponse

readListPrec :: ReadPrec [CreateMembersResponse]

Show CreateMembersResponse

Defined in Amazonka.Detective.CreateMembers

Methods

showsPrec :: Int -> CreateMembersResponse -> ShowS

show :: CreateMembersResponse -> String

showList :: [CreateMembersResponse] -> ShowS

NFData CreateMembersResponse

Defined in Amazonka.Detective.CreateMembers

Methods

rnf :: CreateMembersResponse -> ()

Eq CreateMembersResponse

Defined in Amazonka.Detective.CreateMembers

Methods

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

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

type Rep CreateMembersResponse

Defined in Amazonka.Detective.CreateMembers

type Rep CreateMembersResponse = D1 ('MetaData "CreateMembersResponse" "Amazonka.Detective.CreateMembers" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" '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

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 or enablement 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 or are being enabled.

$sel:unprocessedAccounts:CreateMembersResponse', createMembersResponse_unprocessedAccounts - The list of accounts for which Detective was unable to process the invitation or enablement 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])

The set of member account invitation or enablement 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 or are being enabled.

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

The list of accounts for which Detective was unable to process the invitation or enablement 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

The response's http status code.