| 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.ListMembers
Description
Retrieves the list of member accounts for a behavior graph.
For invited accounts, the results do not include member accounts that were removed from the behavior graph.
For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.
Synopsis
- data ListMembers = ListMembers' {}
- newListMembers :: Text -> ListMembers
- listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
- listMembers_nextToken :: Lens' ListMembers (Maybe Text)
- listMembers_graphArn :: Lens' ListMembers Text
- data ListMembersResponse = ListMembersResponse' {
- memberDetails :: Maybe [MemberDetail]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListMembersResponse :: Int -> ListMembersResponse
- listMembersResponse_memberDetails :: Lens' ListMembersResponse (Maybe [MemberDetail])
- listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text)
- listMembersResponse_httpStatus :: Lens' ListMembersResponse Int
Creating a Request
data ListMembers Source #
See: newListMembers smart constructor.
Constructors
| ListMembers' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListMembers |
Create a value of ListMembers 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:maxResults:ListMembers', listMembers_maxResults - The maximum number of member accounts to include in the response. The
total must be less than the overall limit on the number of results to
return, which is currently 200.
ListMembers, listMembers_nextToken - For requests to retrieve the next page of member account results, the
pagination token that was returned with the previous page of results.
The initial request does not include a pagination token.
ListMembers, listMembers_graphArn - The ARN of the behavior graph for which to retrieve the list of member
accounts.
Request Lenses
listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #
The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.
listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #
For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.
listMembers_graphArn :: Lens' ListMembers Text Source #
The ARN of the behavior graph for which to retrieve the list of member accounts.
Destructuring the Response
data ListMembersResponse Source #
See: newListMembersResponse smart constructor.
Constructors
| ListMembersResponse' | |
Fields
| |
Instances
newListMembersResponse Source #
Arguments
| :: Int | |
| -> ListMembersResponse |
Create a value of ListMembersResponse 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:memberDetails:ListMembersResponse', listMembersResponse_memberDetails - The list of member accounts in the behavior graph.
For invited accounts, the results include member accounts that did not pass verification and member accounts that have not yet accepted the invitation to the behavior graph. The results do not include member accounts that were removed from the behavior graph.
For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.
ListMembers, listMembersResponse_nextToken - If there are more member accounts remaining in the results, then use
this pagination token to request the next page of member accounts.
$sel:httpStatus:ListMembersResponse', listMembersResponse_httpStatus - The response's http status code.
Response Lenses
listMembersResponse_memberDetails :: Lens' ListMembersResponse (Maybe [MemberDetail]) Source #
The list of member accounts in the behavior graph.
For invited accounts, the results include member accounts that did not pass verification and member accounts that have not yet accepted the invitation to the behavior graph. The results do not include member accounts that were removed from the behavior graph.
For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.
listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #
If there are more member accounts remaining in the results, then use this pagination token to request the next page of member accounts.
listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #
The response's http status code.