list_networks

ManagedBlockchain.Client.list_networks(**kwargs)

Returns information about the networks in which the current Amazon Web Services account participates.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.list_networks(
    Name='string',
    Framework='HYPERLEDGER_FABRIC'|'ETHEREUM',
    Status='CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
    MaxResults=123,
    NextToken='string'
)

Parameters

• Name (string) -- The name of the network.
• Framework (string) -- An optional framework specifier. If provided, only networks of this framework type are listed.
• Status (string) --

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

  Applies only to Hyperledger Fabric.

• MaxResults (integer) -- The maximum number of networks to list.
• NextToken (string) -- The pagination token that indicates the next set of results to retrieve.

Return type

dict

Returns

Response Syntax

{
    'Networks': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'Framework': 'HYPERLEDGER_FABRIC'|'ETHEREUM',
            'FrameworkVersion': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
            'CreationDate': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Networks (list) --

    An array of NetworkSummary objects that contain configuration properties for each network.

    • (dict) --

      A summary of network configuration properties.

      • Id (string) --

        The unique identifier of the network.

      • Name (string) --

        The name of the network.

      • Description (string) --

        An optional description of the network.

      • Framework (string) --

        The blockchain framework that the network uses.

      • FrameworkVersion (string) --

        The version of the blockchain framework that the network uses.

      • Status (string) --

        The current status of the network.

      • CreationDate (datetime) --

        The date and time that the network was created.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the network. 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

• ManagedBlockchain.Client.exceptions.InvalidRequestException
• ManagedBlockchain.Client.exceptions.AccessDeniedException
• ManagedBlockchain.Client.exceptions.ThrottlingException
• ManagedBlockchain.Client.exceptions.InternalServiceErrorException