}
URI Request Parameters
The request uses the following URI parameters.
networkId (p. 16)
The unique identifier of the network for which the proposal is made.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
Request Body
The request accepts the following data in JSON format.
Actions (p. 16)
The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.
Type: ProposalActions (p. 117) object
Response Syntax
Required: Yes
ClientRequestToken (p. 16)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes Description (p. 16)
A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."
Type: String
Length Constraints: Maximum length of 128.
Required: No MemberId (p. 16)
The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes Tags (p. 16)
Tags to assign to the proposal. Each tag consists of a key and optional value.
When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
Content-type: application/json { "ProposalId": "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.
ProposalId (p. 17)
The unique identifier of the proposal.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 125).
AccessDeniedException
You do not 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 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ResourceNotReadyException
The requested resource exists but is not in a status that can complete the operation.
HTTP Status Code: 409 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
HTTP Status Code: 429
See Also
TooManyTagsException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteMember
DeleteMember
Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also.
Applies only to Hyperledger Fabric.
Request Syntax
DELETE /networks/networkId/members/memberId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
memberId (p. 20)
The unique identifier of the member to remove.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes networkId (p. 20)
The unique identifier of the network from which the member is removed.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 125).
AccessDeniedException
You do not have sufficient access to perform this action.
See Also
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 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ResourceNotReadyException
The requested resource exists but is not in a status that can complete the operation.
HTTP Status Code: 409 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteNode
DeleteNode
Deletes a node that your AWS account owns. All data on the node is lost and cannot be recovered.
Applies to Hyperledger Fabric and Ethereum.
Request Syntax
DELETE /networks/networkId/nodes/nodeId?memberId=MemberId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MemberId (p. 22)
The unique identifier of the member that owns this node.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
Length Constraints: Minimum length of 1. Maximum length of 32.
networkId (p. 22)
The unique identifier of the network that the node is on.
Ethereum public networks have the following NetworkIds:
• n-ethereum-mainnet
• n-ethereum-rinkeby
• n-ethereum-ropsten
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes nodeId (p. 22)
The unique identifier of the node.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 125).
AccessDeniedException
You do not 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 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ResourceNotReadyException
The requested resource exists but is not in a status that can complete the operation.
HTTP Status Code: 409 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetMember
GetMember
Returns detailed information about a member.
Applies only to Hyperledger Fabric.
Request Syntax
GET /networks/networkId/members/memberId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
memberId (p. 24)
The unique identifier of the member.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes networkId (p. 24)
The unique identifier of the network to which the member belongs.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"Description": "string", "FrameworkAttributes": {"LogPublishingConfiguration": { "Fabric": {
"CaLogs": { "Cloudwatch": {
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.
Member (p. 24)
The properties of a member.
Type: Member (p. 80) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 125).
AccessDeniedException
You do not 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 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
HTTP Status Code: 429
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetNetwork
GetNetwork
Returns detailed information about a network.
Applies to Hyperledger Fabric and Ethereum.
Request Syntax
GET /networks/networkId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
networkId (p. 27)
The unique identifier of the network to get information about.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"Description": "string", "Framework": "string","FrameworkVersion": "string", "Id": "string",
Response Elements
"ThresholdComparator": "string", "ThresholdPercentage": number }
},
"VpcEndpointServiceName": "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.
Network (p. 27)
An object containing network configuration parameters.
Type: Network (p. 93) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 125).
AccessDeniedException
You do not 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 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetNode
GetNode
Returns detailed information about a node.
Applies to Hyperledger Fabric and Ethereum.
Request Syntax
GET /networks/networkId/nodes/nodeId?memberId=MemberId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MemberId (p. 30)
The unique identifier of the member that owns the node.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
Length Constraints: Minimum length of 1. Maximum length of 32.
networkId (p. 30)
The unique identifier of the network that the node is on.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes nodeId (p. 30)
The unique identifier of the node.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Node": {
"Arn": "string",
"AvailabilityZone": "string", "CreationDate": number, "FrameworkAttributes": { "Ethereum": {
"HttpEndpoint": "string",
Response Elements
"InstanceType": "string", "KmsKeyArn": "string",
"LogPublishingConfiguration": { "Fabric": {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Node (p. 30)
Properties of the node configuration.
Type: Node (p. 103) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 125).
AccessDeniedException
You do not 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
See Also
InvalidRequestException
The action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetProposal
GetProposal
Returns detailed information about a proposal.
Applies only to Hyperledger Fabric.
Request Syntax
GET /networks/networkId/proposals/proposalId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
networkId (p. 33)
The unique identifier of the network for which the proposal is made.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes proposalId (p. 33)
The unique identifier of the proposal.
Length Constraints: Minimum length of 1. Maximum length of 32.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"Description": "string",Response Elements
"ExpirationDate": number, "NetworkId": "string", "NoVoteCount": number,
"OutstandingVoteCount": number, "ProposalId": "string",
"ProposedByMemberId": "string", "ProposedByMemberName": "string", "Status": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Proposal (p. 33)
Information about a proposal.
Type: Proposal (p. 114) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 125).
AccessDeniedException
You do not 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 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
HTTP Status Code: 429
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListInvitations
ListInvitations
Returns a list of all invitations for the current AWS account.
Applies only to Hyperledger Fabric.
Request Syntax
GET /invitations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 36)
The maximum number of invitations to return.
Valid Range: Minimum value of 1. Maximum value of 100.
NextToken (p. 36)
The pagination token that indicates the next set of results to retrieve.
Length Constraints: Maximum length of 128.
Request Body
The request does not have a request body.
Response Syntax
"NextToken": "string"
Response Elements
}
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.
Invitations (p. 36)
The invitations for the network.
Type: Array of Invitation (p. 75) objects NextToken (p. 36)
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 (p. 125).
AccessDeniedException
You do not 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 ResourceLimitExceededException
The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.
HTTP Status Code: 429 ResourceNotFoundException
A requested resource does not exist. It may have been deleted or referenced inaccurately.
HTTP Status Code: 404 ThrottlingException
The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.
See Also
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListMembers
ListMembers
Returns a list of the members in a network and properties of their configurations.
Applies only to Hyperledger Fabric.
Request Syntax
GET /networks/networkId/members?
isOwned=IsOwned&maxResults=MaxResults&name=Name&nextToken=NextToken&status=Status HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
IsOwned (p. 39)
An optional Boolean value. If provided, the request is limited either to members that the current AWS account owns (true) or that other AWS accounts own (false). If omitted, all members are listed.
MaxResults (p. 39)
The maximum number of members to return in the request.
Valid Range: Minimum value of 1. Maximum value of 20.
Name (p. 39)
The optional name of the member to list.
networkId (p. 39)
The unique identifier of the network for which to list members.
The unique identifier of the network for which to list members.