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.ManagedBlockChain.ListNodes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

Synopsis

data ListNodes = ListNodes' {
- maxResults :: Maybe Natural
- memberId :: Maybe Text
- nextToken :: Maybe Text
- status :: Maybe NodeStatus
- networkId :: Text
}
newListNodes :: Text -> ListNodes
listNodes_maxResults :: Lens' ListNodes (Maybe Natural)
listNodes_memberId :: Lens' ListNodes (Maybe Text)
listNodes_nextToken :: Lens' ListNodes (Maybe Text)
listNodes_status :: Lens' ListNodes (Maybe NodeStatus)
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

data ListNodes Source #

See: newListNodes smart constructor.

Constructors

ListNodes'

Fields

maxResults :: Maybe Natural
The maximum number of nodes to list.
memberId :: Maybe Text
The unique identifier of the member who owns the nodes to list.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
nextToken :: Maybe Text
The pagination token that indicates the next set of results to retrieve.
status :: Maybe NodeStatus
An optional status specifier. If provided, only nodes currently in this status are listed.
networkId :: Text
The unique identifier of the network for which to list nodes.

Instances

Instances details

ToHeaders ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods toHeaders :: ListNodes -> [Header] #
ToPath ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods toPath :: ListNodes -> ByteString #
ToQuery ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods toQuery :: ListNodes -> QueryString #
AWSRequest ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Associated Types type AWSResponse ListNodes # Methods request :: (Service -> Service) -> ListNodes -> Request ListNodes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListNodes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListNodes))) #
Generic ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Associated Types type Rep ListNodes :: Type -> Type # Methods from :: ListNodes -> Rep ListNodes x # to :: Rep ListNodes x -> ListNodes #
Read ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods readsPrec :: Int -> ReadS ListNodes # readList :: ReadS [ListNodes] # readPrec :: ReadPrec ListNodes # readListPrec :: ReadPrec [ListNodes] #
Show ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods showsPrec :: Int -> ListNodes -> ShowS # show :: ListNodes -> String # showList :: [ListNodes] -> ShowS #
NFData ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods rnf :: ListNodes -> () #
Eq ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods (==) :: ListNodes -> ListNodes -> Bool # (/=) :: ListNodes -> ListNodes -> Bool #
Hashable ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods hashWithSalt :: Int -> ListNodes -> Int # hash :: ListNodes -> Int #
type AWSResponse ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes type AWSResponse ListNodes = ListNodesResponse
type Rep ListNodes Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes type Rep ListNodes = D1 ('MetaData "ListNodes" "Amazonka.ManagedBlockChain.ListNodes" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "ListNodes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "memberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeStatus)) :: S1 ('MetaSel ('Just "networkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListNodes Source #

Arguments

:: Text	`ListNodes`
-> ListNodes

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:maxResults:ListNodes', listNodes_maxResults - The maximum number of nodes to list.

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.

ListNodes, listNodes_nextToken - The pagination token that indicates the next set of results to retrieve.

ListNodes, listNodes_status - An optional status specifier. If provided, only nodes currently in this status are listed.

ListNodes, listNodes_networkId - The unique identifier of the network for which to list nodes.

Request Lenses

listNodes_maxResults :: Lens' ListNodes (Maybe Natural) Source #

The maximum number of nodes to list.

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_status :: Lens' ListNodes (Maybe NodeStatus) Source #

An optional status specifier. If provided, only nodes currently in this status are listed.

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.

Constructors

ListNodesResponse'
Fields nextToken :: Maybe Text The pagination token that indicates the next set of results to retrieve. nodes :: Maybe [NodeSummary] An array of `NodeSummary` objects that contain configuration properties for each node. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListNodesResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Associated Types type Rep ListNodesResponse :: Type -> Type # Methods from :: ListNodesResponse -> Rep ListNodesResponse x # to :: Rep ListNodesResponse x -> ListNodesResponse #
Read ListNodesResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods readsPrec :: Int -> ReadS ListNodesResponse # readList :: ReadS [ListNodesResponse] # readPrec :: ReadPrec ListNodesResponse # readListPrec :: ReadPrec [ListNodesResponse] #
Show ListNodesResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods showsPrec :: Int -> ListNodesResponse -> ShowS # show :: ListNodesResponse -> String # showList :: [ListNodesResponse] -> ShowS #
NFData ListNodesResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods rnf :: ListNodesResponse -> () #
Eq ListNodesResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes Methods (==) :: ListNodesResponse -> ListNodesResponse -> Bool # (/=) :: ListNodesResponse -> ListNodesResponse -> Bool #
type Rep ListNodesResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListNodes type Rep ListNodesResponse = D1 ('MetaData "ListNodesResponse" "Amazonka.ManagedBlockChain.ListNodes" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "ListNodesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NodeSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListNodesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListNodesResponse'`
-> ListNodesResponse

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:

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.