| 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.Inspector2.ListMembers
Description
List members associated with the Amazon Inspector delegated administrator for your organization.
This operation returns paginated results.
Synopsis
- data ListMembers = ListMembers' {}
- newListMembers :: ListMembers
- listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
- listMembers_nextToken :: Lens' ListMembers (Maybe Text)
- listMembers_onlyAssociated :: Lens' ListMembers (Maybe Bool)
- 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:maxResults:ListMembers', listMembers_maxResults - The maximum number of results to return in the response.
ListMembers, listMembers_nextToken - A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken value returned from
the previous request to continue listing results after the first page.
$sel:onlyAssociated:ListMembers', listMembers_onlyAssociated - Specifies whether to list only currently associated members if True or
to list all members within the organization if False.
Request Lenses
listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #
The maximum number of results to return in the response.
listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #
A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken value returned from
the previous request to continue listing results after the first page.
listMembers_onlyAssociated :: Lens' ListMembers (Maybe Bool) Source #
Specifies whether to list only currently associated members if True or
to list all members within the organization if False.
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 - An object that contains details for each member account.
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 #
An object that contains details for each member account.
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.