| 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.DeleteMembers
Description
Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph.
For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation.
For organization accounts in the organization behavior graph, the
Detective administrator account can always enable the organization
account again. Organization accounts that are not enabled as member
accounts are not included in the ListMembers results for the
organization behavior graph.
An administrator account cannot use DeleteMembers to remove their own
account from the behavior graph. To disable a behavior graph, the
administrator account uses the DeleteGraph API method.
Synopsis
- data DeleteMembers = DeleteMembers' {
- graphArn :: Text
- accountIds :: NonEmpty Text
- newDeleteMembers :: Text -> NonEmpty Text -> DeleteMembers
- deleteMembers_graphArn :: Lens' DeleteMembers Text
- deleteMembers_accountIds :: Lens' DeleteMembers (NonEmpty Text)
- data DeleteMembersResponse = DeleteMembersResponse' {}
- newDeleteMembersResponse :: Int -> DeleteMembersResponse
- deleteMembersResponse_accountIds :: Lens' DeleteMembersResponse (Maybe (NonEmpty Text))
- deleteMembersResponse_unprocessedAccounts :: Lens' DeleteMembersResponse (Maybe [UnprocessedAccount])
- deleteMembersResponse_httpStatus :: Lens' DeleteMembersResponse Int
Creating a Request
data DeleteMembers Source #
See: newDeleteMembers smart constructor.
Constructors
| DeleteMembers' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> DeleteMembers |
Create a value of DeleteMembers 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:
DeleteMembers, deleteMembers_graphArn - The ARN of the behavior graph to remove members from.
DeleteMembers, deleteMembers_accountIds - The list of Amazon Web Services account identifiers for the member
accounts to remove from the behavior graph. You can remove up to 50
member accounts at a time.
Request Lenses
deleteMembers_graphArn :: Lens' DeleteMembers Text Source #
The ARN of the behavior graph to remove members from.
deleteMembers_accountIds :: Lens' DeleteMembers (NonEmpty Text) Source #
The list of Amazon Web Services account identifiers for the member accounts to remove from the behavior graph. You can remove up to 50 member accounts at a time.
Destructuring the Response
data DeleteMembersResponse Source #
See: newDeleteMembersResponse smart constructor.
Constructors
| DeleteMembersResponse' | |
Fields
| |
Instances
newDeleteMembersResponse Source #
Create a value of DeleteMembersResponse 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:
DeleteMembers, deleteMembersResponse_accountIds - The list of Amazon Web Services account identifiers for the member
accounts that Detective successfully removed from the behavior graph.
$sel:unprocessedAccounts:DeleteMembersResponse', deleteMembersResponse_unprocessedAccounts - The list of member accounts that Detective was not able to remove from
the behavior graph. For each member account, provides the reason that
the deletion could not be processed.
$sel:httpStatus:DeleteMembersResponse', deleteMembersResponse_httpStatus - The response's http status code.
Response Lenses
deleteMembersResponse_accountIds :: Lens' DeleteMembersResponse (Maybe (NonEmpty Text)) Source #
The list of Amazon Web Services account identifiers for the member accounts that Detective successfully removed from the behavior graph.
deleteMembersResponse_unprocessedAccounts :: Lens' DeleteMembersResponse (Maybe [UnprocessedAccount]) Source #
The list of member accounts that Detective was not able to remove from the behavior graph. For each member account, provides the reason that the deletion could not be processed.
deleteMembersResponse_httpStatus :: Lens' DeleteMembersResponse Int Source #
The response's http status code.