Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . managedblockchain ]

list-networks

Description

Returns information about the networks in which the current AWS account has members.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-networks
[--name <value>]
[--framework <value>]
[--status <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the network.

--framework (string)

An optional framework specifier. If provided, only networks of this framework type are listed.

Possible values:

  • HYPERLEDGER_FABRIC

--status (string)

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

Possible values:

  • CREATING
  • AVAILABLE
  • CREATE_FAILED
  • DELETING
  • DELETED

--max-results (integer)

The maximum number of networks to list.

--next-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Networks -> (list)

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

(structure)

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 -> (timestamp)

The date and time that the network was created.

NextToken -> (string)

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