| Copyright | (c) 2013-2021 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 |
Amazonka.MacieV2.ListMembers
Description
Retrieves information about the accounts that are associated with an Amazon Macie administrator account.
This operation returns paginated results.
Synopsis
- data ListMembers = ListMembers' {}
- newListMembers :: ListMembers
- listMembers_nextToken :: Lens' ListMembers (Maybe Text)
- listMembers_onlyAssociated :: Lens' ListMembers (Maybe Text)
- listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
- 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
newListMembers :: ListMembers Source #
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:nextToken:ListMembers', listMembers_nextToken - The nextToken string that specifies which page of results to return in a
paginated response.
$sel:onlyAssociated:ListMembers', listMembers_onlyAssociated - Specifies which accounts to include in the response, based on the status
of an account's relationship with the administrator account. By
default, the response includes only current member accounts. To include
all accounts, set this value to false.
$sel:maxResults:ListMembers', listMembers_maxResults - The maximum number of items to include in each page of a paginated
response.
Request Lenses
listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #
The nextToken string that specifies which page of results to return in a paginated response.
listMembers_onlyAssociated :: Lens' ListMembers (Maybe Text) Source #
Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.
listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #
The maximum number of items to include in each page of a paginated response.
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:members:ListMembersResponse', listMembersResponse_members - An array of objects, one for each account that's associated with the
administrator account and meets the criteria specified by the
onlyAssociated request parameter.
$sel:nextToken:ListMembers', listMembersResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:httpStatus:ListMembersResponse', listMembersResponse_httpStatus - The response's http status code.
Response Lenses
listMembersResponse_members :: Lens' ListMembersResponse (Maybe [Member]) Source #
An array of objects, one for each account that's associated with the administrator account and meets the criteria specified by the onlyAssociated request parameter.
listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #
The response's http status code.