| 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.FMS.ListMemberAccounts
Description
Returns a MemberAccounts object that lists the member accounts in the
administrator's Amazon Web Services organization.
The ListMemberAccounts must be submitted by the account that is set as
the Firewall Manager administrator.
This operation returns paginated results.
Synopsis
- data ListMemberAccounts = ListMemberAccounts' {}
- newListMemberAccounts :: ListMemberAccounts
- listMemberAccounts_maxResults :: Lens' ListMemberAccounts (Maybe Natural)
- listMemberAccounts_nextToken :: Lens' ListMemberAccounts (Maybe Text)
- data ListMemberAccountsResponse = ListMemberAccountsResponse' {
- memberAccounts :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListMemberAccountsResponse :: Int -> ListMemberAccountsResponse
- listMemberAccountsResponse_memberAccounts :: Lens' ListMemberAccountsResponse (Maybe [Text])
- listMemberAccountsResponse_nextToken :: Lens' ListMemberAccountsResponse (Maybe Text)
- listMemberAccountsResponse_httpStatus :: Lens' ListMemberAccountsResponse Int
Creating a Request
data ListMemberAccounts Source #
See: newListMemberAccounts smart constructor.
Constructors
| ListMemberAccounts' | |
Fields
| |
Instances
newListMemberAccounts :: ListMemberAccounts Source #
Create a value of ListMemberAccounts 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:ListMemberAccounts', listMemberAccounts_maxResults - Specifies the number of member account IDs that you want Firewall
Manager to return for this request. If you have more IDs than the number
that you specify for MaxResults, the response includes a NextToken
value that you can use to get another batch of member account IDs.
ListMemberAccounts, listMemberAccounts_nextToken - If you specify a value for MaxResults and you have more account IDs
than the number that you specify for MaxResults, Firewall Manager
returns a NextToken value in the response that allows you to list
another group of IDs. For the second and subsequent
ListMemberAccountsRequest requests, specify the value of NextToken
from the previous response to get information about another batch of
member account IDs.
Request Lenses
listMemberAccounts_maxResults :: Lens' ListMemberAccounts (Maybe Natural) Source #
Specifies the number of member account IDs that you want Firewall
Manager to return for this request. If you have more IDs than the number
that you specify for MaxResults, the response includes a NextToken
value that you can use to get another batch of member account IDs.
listMemberAccounts_nextToken :: Lens' ListMemberAccounts (Maybe Text) Source #
If you specify a value for MaxResults and you have more account IDs
than the number that you specify for MaxResults, Firewall Manager
returns a NextToken value in the response that allows you to list
another group of IDs. For the second and subsequent
ListMemberAccountsRequest requests, specify the value of NextToken
from the previous response to get information about another batch of
member account IDs.
Destructuring the Response
data ListMemberAccountsResponse Source #
See: newListMemberAccountsResponse smart constructor.
Constructors
| ListMemberAccountsResponse' | |
Fields
| |
Instances
newListMemberAccountsResponse Source #
Create a value of ListMemberAccountsResponse 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:memberAccounts:ListMemberAccountsResponse', listMemberAccountsResponse_memberAccounts - An array of account IDs.
ListMemberAccounts, listMemberAccountsResponse_nextToken - If you have more member account IDs than the number that you specified
for MaxResults in the request, the response includes a NextToken
value. To list more IDs, submit another ListMemberAccounts request,
and specify the NextToken value from the response in the NextToken
value in the next request.
$sel:httpStatus:ListMemberAccountsResponse', listMemberAccountsResponse_httpStatus - The response's http status code.
Response Lenses
listMemberAccountsResponse_memberAccounts :: Lens' ListMemberAccountsResponse (Maybe [Text]) Source #
An array of account IDs.
listMemberAccountsResponse_nextToken :: Lens' ListMemberAccountsResponse (Maybe Text) Source #
If you have more member account IDs than the number that you specified
for MaxResults in the request, the response includes a NextToken
value. To list more IDs, submit another ListMemberAccounts request,
and specify the NextToken value from the response in the NextToken
value in the next request.
listMemberAccountsResponse_httpStatus :: Lens' ListMemberAccountsResponse Int Source #
The response's http status code.