Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListNetworks

Returns information about the networks in which the current AWS account participates.

Applies to Hyperledger Fabric and Ethereum.

Request Syntax


GET /networks?framework=Framework&maxResults=MaxResults&name=Name&nextToken=NextToken&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Framework

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

Valid Values: HYPERLEDGER_FABRIC | ETHEREUM

MaxResults

The maximum number of networks to list.

Valid Range: Minimum value of 1. Maximum value of 10.

Name

The name of the network.

NextToken

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

Length Constraints: Maximum length of 128.

Status

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

Applies only to Hyperledger Fabric.

Valid Values: CREATING | AVAILABLE | CREATE_FAILED | DELETING | DELETED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Networks": [ 
      { 
         "Arn": "string",
         "CreationDate": "string",
         "Description": "string",
         "Framework": "string",
         "FrameworkVersion": "string",
         "Id": "string",
         "Name": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Networks

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

Type: Array of NetworkSummary objects

NextToken

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

Type: String

Length Constraints: Maximum length of 128.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceErrorException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidRequestException

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

ThrottlingException

The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.

HTTP Status Code: 429