@aws-sdk/client-managedblockchain
TypeScript icon, indicating that this package has built-in type declarations

3.540.0 • Public • Published

@aws-sdk/client-managedblockchain

Description

AWS SDK for JavaScript ManagedBlockchain Client for Node.js, Browser and React Native.

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.

Installing

To install the this package, simply type add or install @aws-sdk/client-managedblockchain using your favorite package manager:

  • npm install @aws-sdk/client-managedblockchain
  • yarn add @aws-sdk/client-managedblockchain
  • pnpm add @aws-sdk/client-managedblockchain

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the ManagedBlockchainClient and the commands you need, for example ListAccessorsCommand:

// ES5 example
const { ManagedBlockchainClient, ListAccessorsCommand } = require("@aws-sdk/client-managedblockchain");
// ES6+ example
import { ManagedBlockchainClient, ListAccessorsCommand } from "@aws-sdk/client-managedblockchain";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new ManagedBlockchainClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListAccessorsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-managedblockchain";
const client = new AWS.ManagedBlockchain({ region: "REGION" });

// async/await.
try {
  const data = await client.listAccessors(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listAccessors(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listAccessors(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-managedblockchain package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateAccessor

Command API Reference / Input / Output

CreateMember

Command API Reference / Input / Output

CreateNetwork

Command API Reference / Input / Output

CreateNode

Command API Reference / Input / Output

CreateProposal

Command API Reference / Input / Output

DeleteAccessor

Command API Reference / Input / Output

DeleteMember

Command API Reference / Input / Output

DeleteNode

Command API Reference / Input / Output

GetAccessor

Command API Reference / Input / Output

GetMember

Command API Reference / Input / Output

GetNetwork

Command API Reference / Input / Output

GetNode

Command API Reference / Input / Output

GetProposal

Command API Reference / Input / Output

ListAccessors

Command API Reference / Input / Output

ListInvitations

Command API Reference / Input / Output

ListMembers

Command API Reference / Input / Output

ListNetworks

Command API Reference / Input / Output

ListNodes

Command API Reference / Input / Output

ListProposals

Command API Reference / Input / Output

ListProposalVotes

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

RejectInvitation

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateMember

Command API Reference / Input / Output

UpdateNode

Command API Reference / Input / Output

VoteOnProposal

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-managedblockchain

Weekly Downloads

73,755

Version

3.540.0

License

Apache-2.0

Unpacked Size

620 kB

Total Files

176

Last publish

Collaborators

  • mattsb42-aws
  • kuhe
  • amzn-oss
  • aws-sdk-bot
  • trivikr-aws