Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists details about all member accounts for the current GuardDuty master account.
This operation returns paginated results.
Synopsis
- listMembers :: Text -> ListMembers
- data ListMembers
- lmOnlyAssociated :: Lens' ListMembers (Maybe Text)
- lmNextToken :: Lens' ListMembers (Maybe Text)
- lmMaxResults :: Lens' ListMembers (Maybe Natural)
- lmDetectorId :: Lens' ListMembers Text
- listMembersResponse :: Int -> ListMembersResponse
- data ListMembersResponse
- lmrsMembers :: Lens' ListMembersResponse [Member]
- lmrsNextToken :: Lens' ListMembersResponse (Maybe Text)
- lmrsResponseStatus :: Lens' ListMembersResponse Int
Creating a Request
Creates a value of ListMembers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmOnlyAssociated
- Specifies what member accounts the response is to include based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response will include member accounts whose relationship status with the master is set to Enabled, Disabled. If onlyAssociated is set to FALSE, the response will include all existing member accounts.lmNextToken
- You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMembers action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.lmMaxResults
- You can use this parameter to indicate the maximum number of items you want in the response. The default value is 1. The maximum value is 50.lmDetectorId
- The unique ID of the detector of the GuardDuty account whose members you want to list.
data ListMembers Source #
See: listMembers
smart constructor.
Instances
Request Lenses
lmOnlyAssociated :: Lens' ListMembers (Maybe Text) Source #
Specifies what member accounts the response is to include based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response will include member accounts whose relationship status with the master is set to Enabled, Disabled. If onlyAssociated is set to FALSE, the response will include all existing member accounts.
lmNextToken :: 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 ListMembers action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
lmMaxResults :: 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 1. The maximum value is 50.
lmDetectorId :: Lens' ListMembers Text Source #
The unique ID of the detector of the GuardDuty account whose members you want to list.
Destructuring the Response
Creates a value of ListMembersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmrsMembers
- Undocumented member.lmrsNextToken
- Undocumented member.lmrsResponseStatus
- -- | The response status code.
data ListMembersResponse Source #
See: listMembersResponse
smart constructor.
Instances
Response Lenses
lmrsMembers :: Lens' ListMembersResponse [Member] Source #
Undocumented member.
lmrsNextToken :: Lens' ListMembersResponse (Maybe Text) Source #
Undocumented member.
lmrsResponseStatus :: Lens' ListMembersResponse Int Source #
- - | The response status code.