| 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.GuardDuty.CreateMembers
Description
Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services 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
- data CreateMembers = CreateMembers' {}
- newCreateMembers :: Text -> NonEmpty AccountDetail -> CreateMembers
- createMembers_detectorId :: Lens' CreateMembers Text
- createMembers_accountDetails :: Lens' CreateMembers (NonEmpty AccountDetail)
- data CreateMembersResponse = CreateMembersResponse' {}
- newCreateMembersResponse :: Int -> CreateMembersResponse
- createMembersResponse_httpStatus :: Lens' CreateMembersResponse Int
- createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse [UnprocessedAccount]
Creating a Request
data CreateMembers Source #
See: newCreateMembers smart constructor.
Constructors
| CreateMembers' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty AccountDetail | |
| -> 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:
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
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_httpStatus :: Lens' CreateMembersResponse Int Source #
The response's http status code.
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.