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 |
Returns information about the nodes within a network.
Applies to Hyperledger Fabric and Ethereum.
Synopsis
- data ListNodes = ListNodes' {}
- newListNodes :: Text -> ListNodes
- listNodes_status :: Lens' ListNodes (Maybe NodeStatus)
- listNodes_memberId :: Lens' ListNodes (Maybe Text)
- listNodes_nextToken :: Lens' ListNodes (Maybe Text)
- listNodes_maxResults :: Lens' ListNodes (Maybe Natural)
- listNodes_networkId :: Lens' ListNodes Text
- data ListNodesResponse = ListNodesResponse' {
- nextToken :: Maybe Text
- nodes :: Maybe [NodeSummary]
- httpStatus :: Int
- newListNodesResponse :: Int -> ListNodesResponse
- listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text)
- listNodesResponse_nodes :: Lens' ListNodesResponse (Maybe [NodeSummary])
- listNodesResponse_httpStatus :: Lens' ListNodesResponse Int
Creating a Request
See: newListNodes
smart constructor.
ListNodes' | |
|
Instances
Create a value of ListNodes
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:ListNodes'
, listNodes_status
- An optional status specifier. If provided, only nodes currently in this
status are listed.
$sel:memberId:ListNodes'
, listNodes_memberId
- The unique identifier of the member who owns the nodes to list.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
$sel:nextToken:ListNodes'
, listNodes_nextToken
- The pagination token that indicates the next set of results to retrieve.
$sel:maxResults:ListNodes'
, listNodes_maxResults
- The maximum number of nodes to list.
$sel:networkId:ListNodes'
, listNodes_networkId
- The unique identifier of the network for which to list nodes.
Request Lenses
listNodes_status :: Lens' ListNodes (Maybe NodeStatus) Source #
An optional status specifier. If provided, only nodes currently in this status are listed.
listNodes_memberId :: Lens' ListNodes (Maybe Text) Source #
The unique identifier of the member who owns the nodes to list.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
listNodes_nextToken :: Lens' ListNodes (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listNodes_maxResults :: Lens' ListNodes (Maybe Natural) Source #
The maximum number of nodes to list.
listNodes_networkId :: Lens' ListNodes Text Source #
The unique identifier of the network for which to list nodes.
Destructuring the Response
data ListNodesResponse Source #
See: newListNodesResponse
smart constructor.
ListNodesResponse' | |
|
Instances
Create a value of ListNodesResponse
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:ListNodes'
, listNodesResponse_nextToken
- The pagination token that indicates the next set of results to retrieve.
$sel:nodes:ListNodesResponse'
, listNodesResponse_nodes
- An array of NodeSummary
objects that contain configuration properties
for each node.
$sel:httpStatus:ListNodesResponse'
, listNodesResponse_httpStatus
- The response's http status code.
Response Lenses
listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listNodesResponse_nodes :: Lens' ListNodesResponse (Maybe [NodeSummary]) Source #
An array of NodeSummary
objects that contain configuration properties
for each node.
listNodesResponse_httpStatus :: Lens' ListNodesResponse Int Source #
The response's http status code.