AWS.ManagedBlockchain — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.

Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember don't apply to Ethereum.

The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.

Sending a Request Using ManagedBlockchain

var managedblockchain = new AWS.ManagedBlockchain();
managedblockchain.createAccessor(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ManagedBlockchain object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var managedblockchain = new AWS.ManagedBlockchain({apiVersion: '2018-09-24'});

You can also set the API version globally in AWS.config.apiVersions using the managedblockchain service identifier:

AWS.config.apiVersions = {
  managedblockchain: '2018-09-24',
  // other service API versions
};

var managedblockchain = new AWS.ManagedBlockchain();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ManagedBlockchain(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createAccessor(params = {}, callback) ⇒ AWS.Request

Creates a new accessor for use with Amazon Managed Blockchain service that supports token based access. The accessor contains information required for token based access.

createMember(params = {}, callback) ⇒ AWS.Request

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

createNetwork(params = {}, callback) ⇒ AWS.Request

Creates a new blockchain network using Amazon Managed Blockchain.

Applies only to Hyperledger Fabric.

createNode(params = {}, callback) ⇒ AWS.Request

Creates a node on the specified blockchain network.

Applies to Hyperledger Fabric and Ethereum.

createProposal(params = {}, callback) ⇒ AWS.Request

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

Applies only to Hyperledger Fabric.

deleteAccessor(params = {}, callback) ⇒ AWS.Request

Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).

deleteMember(params = {}, callback) ⇒ AWS.Request

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 Amazon Web Services 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 Amazon Web Services account, the network is deleted also.

Applies only to Hyperledger Fabric.

deleteNode(params = {}, callback) ⇒ AWS.Request

Deletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered.

Applies to Hyperledger Fabric and Ethereum.

getAccessor(params = {}, callback) ⇒ AWS.Request

Returns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.

getMember(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a member.

Applies only to Hyperledger Fabric.

getNetwork(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a network.

Applies to Hyperledger Fabric and Ethereum.

getNode(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a node.

Applies to Hyperledger Fabric and Ethereum.

getProposal(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a proposal.

Applies only to Hyperledger Fabric.

listAccessors(params = {}, callback) ⇒ AWS.Request

Returns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.

listInvitations(params = {}, callback) ⇒ AWS.Request

Returns a list of all invitations for the current Amazon Web Services account.

Applies only to Hyperledger Fabric.

listMembers(params = {}, callback) ⇒ AWS.Request

Returns a list of the members in a network and properties of their configurations.

Applies only to Hyperledger Fabric.

listNetworks(params = {}, callback) ⇒ AWS.Request

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

Applies to Hyperledger Fabric and Ethereum.

listNodes(params = {}, callback) ⇒ AWS.Request

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

listProposals(params = {}, callback) ⇒ AWS.Request

Returns a list of proposals for the network.

Applies only to Hyperledger Fabric.

listProposalVotes(params = {}, callback) ⇒ AWS.Request

Returns the list of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

Applies only to Hyperledger Fabric.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of tags for the specified resource. Each tag consists of a key and optional value.

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.

rejectInvitation(params = {}, callback) ⇒ AWS.Request

Rejects an invitation to join a network. This action can be called by a principal in an Amazon Web Services account that has received an invitation to create a member and join a network.

Applies only to Hyperledger Fabric.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value.

When you specify a tag key that already exists, the tag value is overwritten with the new value. Use UntagResource to remove tag keys.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the specified tags from the Amazon Managed Blockchain resource.

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.

updateMember(params = {}, callback) ⇒ AWS.Request

Updates a member configuration with new parameters.

Applies only to Hyperledger Fabric.

updateNode(params = {}, callback) ⇒ AWS.Request

Updates a node configuration with new parameters.

Applies only to Hyperledger Fabric.

voteOnProposal(params = {}, callback) ⇒ AWS.Request

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same Amazon Web Services account as the principal that calls the action.

Applies only to Hyperledger Fabric.