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.ManagedBlockChain.ListMembers
Description
Returns a list of the members in a network and properties of their configurations.
Applies only to Hyperledger Fabric.
Synopsis
- data ListMembers = ListMembers' {}
- newListMembers :: Text -> ListMembers
- listMembers_status :: Lens' ListMembers (Maybe MemberStatus)
- listMembers_nextToken :: Lens' ListMembers (Maybe Text)
- listMembers_name :: Lens' ListMembers (Maybe Text)
- listMembers_isOwned :: Lens' ListMembers (Maybe Bool)
- listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
- listMembers_networkId :: Lens' ListMembers Text
- data ListMembersResponse = ListMembersResponse' {
- members :: Maybe [MemberSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListMembersResponse :: Int -> ListMembersResponse
- listMembersResponse_members :: Lens' ListMembersResponse (Maybe [MemberSummary])
- 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:status:ListMembers'
, listMembers_status
- An optional status specifier. If provided, only members currently in
this status are listed.
$sel:nextToken:ListMembers'
, listMembers_nextToken
- The pagination token that indicates the next set of results to retrieve.
$sel:name:ListMembers'
, listMembers_name
- The optional name of the member to list.
$sel:isOwned:ListMembers'
, listMembers_isOwned
- An optional Boolean value. If provided, the request is limited either to
members that the current AWS account owns (true
) or that other AWS
accounts own (false
). If omitted, all members are listed.
$sel:maxResults:ListMembers'
, listMembers_maxResults
- The maximum number of members to return in the request.
$sel:networkId:ListMembers'
, listMembers_networkId
- The unique identifier of the network for which to list members.
Request Lenses
listMembers_status :: Lens' ListMembers (Maybe MemberStatus) Source #
An optional status specifier. If provided, only members currently in this status are listed.
listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listMembers_name :: Lens' ListMembers (Maybe Text) Source #
The optional name of the member to list.
listMembers_isOwned :: Lens' ListMembers (Maybe Bool) Source #
An optional Boolean value. If provided, the request is limited either to
members that the current AWS account owns (true
) or that other AWS
accounts own (false
). If omitted, all members are listed.
listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #
The maximum number of members to return in the request.
listMembers_networkId :: Lens' ListMembers Text Source #
The unique identifier of the network for which to list members.
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 MemberSummary
objects. Each object contains details about
a network member.
$sel:nextToken:ListMembers'
, listMembersResponse_nextToken
- The pagination token that indicates the next set of results to retrieve.
$sel:httpStatus:ListMembersResponse'
, listMembersResponse_httpStatus
- The response's http status code.
Response Lenses
listMembersResponse_members :: Lens' ListMembersResponse (Maybe [MemberSummary]) Source #
An array of MemberSummary
objects. Each object contains details about
a network member.
listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #
The response's http status code.