ManagedBlockchain / Client / list_nodes

list_nodes#

ManagedBlockchain.Client.list_nodes(**kwargs)#

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.list_nodes(
    NetworkId='string',
    MemberId='string',
    Status='CREATING'|'AVAILABLE'|'UNHEALTHY'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'INACCESSIBLE_ENCRYPTION_KEY',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • NetworkId (string) –

    [REQUIRED]

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

  • MemberId (string) –

    The unique identifier of the member who owns the nodes to list.

    Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

  • Status (string) – An optional status specifier. If provided, only nodes currently in this status are listed.

  • MaxResults (integer) – The maximum number of nodes to list.

  • NextToken (string) – The pagination token that indicates the next set of results to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Nodes': [
        {
            'Id': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'UNHEALTHY'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'INACCESSIBLE_ENCRYPTION_KEY',
            'CreationDate': datetime(2015, 1, 1),
            'AvailabilityZone': 'string',
            'InstanceType': 'string',
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Nodes (list) –

      An array of NodeSummary objects that contain configuration properties for each node.

      • (dict) –

        A summary of configuration properties for a node.

        • Id (string) –

          The unique identifier of the node.

        • Status (string) –

          The status of the node.

        • CreationDate (datetime) –

          The date and time that the node was created.

        • AvailabilityZone (string) –

          The Availability Zone in which the node exists.

        • InstanceType (string) –

          The EC2 instance type for the node.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • NextToken (string) –

      The pagination token that indicates the next set of results to retrieve.

Exceptions