| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Detective.CreateMembers
Description
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
CreateMemberswas 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
CreateMemberswas unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.
Synopsis
- data CreateMembers = CreateMembers' {}
- newCreateMembers :: Text -> NonEmpty Account -> CreateMembers
- createMembers_disableEmailNotification :: Lens' CreateMembers (Maybe Bool)
- createMembers_message :: Lens' CreateMembers (Maybe Text)
- createMembers_graphArn :: Lens' CreateMembers Text
- createMembers_accounts :: Lens' CreateMembers (NonEmpty Account)
- data CreateMembersResponse = CreateMembersResponse' {}
- newCreateMembersResponse :: Int -> CreateMembersResponse
- createMembersResponse_members :: Lens' CreateMembersResponse (Maybe [MemberDetail])
- createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse (Maybe [UnprocessedAccount])
- createMembersResponse_httpStatus :: Lens' CreateMembersResponse Int
Creating a Request
data CreateMembers Source #
See: newCreateMembers smart constructor.
Constructors
| CreateMembers' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty Account | |
| -> 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) Source #
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) 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.
createMembers_accounts :: Lens' CreateMembers (NonEmpty Account) Source #
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 Source #
See: newCreateMembersResponse smart constructor.
Constructors
| CreateMembersResponse' | |
Fields
| |
Instances
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: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]) Source #
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]) Source #
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 Source #
The response's http status code.