libZSservicesZSamazonka-managedblockchainZSamazonka-managedblockchain
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ManagedBlockChain.ListNodes

Description

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

Synopsis

Creating a Request

data ListNodes Source #

See: newListNodes smart constructor.

Constructors

ListNodes' 

Fields

  • status :: Maybe NodeStatus

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

  • 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.

  • maxResults :: Maybe Natural

    The maximum number of nodes to list.

  • networkId :: Text

    The unique identifier of the network for which to list nodes.

Instances

Instances details
Eq ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Read ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Show ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Generic ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Associated Types

type Rep ListNodes :: Type -> Type #

NFData ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Methods

rnf :: ListNodes -> () #

Hashable ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

AWSRequest ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Associated Types

type AWSResponse ListNodes #

ToHeaders ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Methods

toHeaders :: ListNodes -> [Header] #

ToPath ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

ToQuery ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

type Rep ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

type Rep ListNodes = D1 ('MetaData "ListNodes" "Amazonka.ManagedBlockChain.ListNodes" "libZSservicesZSamazonka-managedblockchainZSamazonka-managedblockchain" 'False) (C1 ('MetaCons "ListNodes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeStatus)) :*: S1 ('MetaSel ('Just "memberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "networkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListNodes Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

newListNodes Source #

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.

Constructors

ListNodesResponse' 

Fields

Instances

Instances details
Eq ListNodesResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Read ListNodesResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Show ListNodesResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Generic ListNodesResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Associated Types

type Rep ListNodesResponse :: Type -> Type #

NFData ListNodesResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

Methods

rnf :: ListNodesResponse -> () #

type Rep ListNodesResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.ListNodes

type Rep ListNodesResponse = D1 ('MetaData "ListNodesResponse" "Amazonka.ManagedBlockChain.ListNodes" "libZSservicesZSamazonka-managedblockchainZSamazonka-managedblockchain" '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 #

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.