| 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.ListMembers
Description
Lists details about all member accounts for the current GuardDuty administrator account.
This operation returns paginated results.
Synopsis
- data ListMembers = ListMembers' {}
- newListMembers :: Text -> ListMembers
- listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
- listMembers_nextToken :: Lens' ListMembers (Maybe Text)
- listMembers_onlyAssociated :: Lens' ListMembers (Maybe Text)
- listMembers_detectorId :: Lens' ListMembers Text
- data ListMembersResponse = ListMembersResponse' {}
- newListMembersResponse :: Int -> ListMembersResponse
- listMembersResponse_members :: Lens' ListMembersResponse (Maybe [Member])
- 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 - You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 50. The maximum value is 50.
ListMembers, listMembers_nextToken - You can use this parameter when paginating results. Set the value of
this parameter to null on your first call to the list action. For
subsequent calls to the action, fill nextToken in the request with the
value of NextToken from the previous response to continue listing data.
$sel:onlyAssociated:ListMembers', listMembers_onlyAssociated - Specifies whether to only return associated members or to return all
members (including members who haven't been invited yet or have been
disassociated). Member accounts must have been previously associated
with the GuardDuty administrator account using
Create Members
.
ListMembers, listMembers_detectorId - The unique ID of the detector the member is associated with.
Request Lenses
listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
listMembers_onlyAssociated :: Lens' ListMembers (Maybe Text) Source #
Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using Create Members .
listMembers_detectorId :: Lens' ListMembers Text Source #
The unique ID of the detector the member is associated with.
Destructuring the Response
data ListMembersResponse Source #
See: newListMembersResponse smart constructor.
Constructors
| ListMembersResponse' | |
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:members:ListMembersResponse', listMembersResponse_members - A list of members.
ListMembers, listMembersResponse_nextToken - The pagination parameter to be used on the next list operation to
retrieve more items.
$sel:httpStatus:ListMembersResponse', listMembersResponse_httpStatus - The response's http status code.
Response Lenses
listMembersResponse_members :: Lens' ListMembersResponse (Maybe [Member]) Source #
A list of members.
listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #
The pagination parameter to be used on the next list operation to retrieve more items.
listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #
The response's http status code.