Amazon Managed Blockchain
API Reference (API Version 2018-09-24)

ListInvitedNetworks

Lists the networks that the AWS account has been invited to be a member of.

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.

Framework

The blockchain framework type.

Valid Values: HYPERLEDGER_FABRIC

MaxResults

The maximum number of networks to show in the 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

Filters the list of networks returned to those with this status.

Valid Values: CREATING | ACTIVE | FAILED | DELETING | DELETED

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "InvitedNetworks": [ { "Description": "string", "Id": "string", "Name": "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.

InvitedNetworks

The networks that the AWS account has been invited to.

Type: Array of InvitedNetworkSummary 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

HTTP Status Code: 403

InternalServiceErrorException

HTTP Status Code: 500

InvalidRequestException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: