AWS.ManagedBlockchain (aws-elixir v0.8.0) View Source

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 do not 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.

Link to this section Summary

Functions

Creates a member within a Managed Blockchain network.

Creates a new blockchain network using Amazon Managed Blockchain.

Creates a node on the specified blockchain network.

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.

Deletes a node that your AWS account owns.

Returns detailed information about a member.

Returns detailed information about a network.

Returns detailed information about a proposal.

Returns a list of all invitations for the current AWS account.

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

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.

Returns a list of tags for the specified resource.

Rejects an invitation to join a network.

Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource.

Removes the specified tags from the Amazon Managed Blockchain resource.

Updates a member configuration with new parameters.

Updates a node configuration with new parameters.

Casts a vote for a specified ProposalId on behalf of a member.

Link to this section Functions

Link to this function

create_member(client, network_id, input, options \\ [])

View Source

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

Link to this function

create_network(client, input, options \\ [])

View Source

Creates a new blockchain network using Amazon Managed Blockchain.

Applies only to Hyperledger Fabric.

Link to this function

create_node(client, network_id, input, options \\ [])

View Source

Creates a node on the specified blockchain network.

Applies to Hyperledger Fabric and Ethereum.

Link to this function

create_proposal(client, network_id, input, options \\ [])

View Source

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.

Link to this function

delete_member(client, member_id, network_id, input, options \\ [])

View Source

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.

Link to this function

delete_node(client, network_id, node_id, input, options \\ [])

View Source

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.

Link to this function

get_member(client, member_id, network_id, options \\ [])

View Source

Returns detailed information about a member.

Applies only to Hyperledger Fabric.

Link to this function

get_network(client, network_id, options \\ [])

View Source

Returns detailed information about a network.

Applies to Hyperledger Fabric and Ethereum.

Link to this function

get_node(client, network_id, node_id, member_id \\ nil, options \\ [])

View Source

Returns detailed information about a node.

Applies to Hyperledger Fabric and Ethereum.

Link to this function

get_proposal(client, network_id, proposal_id, options \\ [])

View Source

Returns detailed information about a proposal.

Applies only to Hyperledger Fabric.

Link to this function

list_invitations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all invitations for the current AWS account.

Applies only to Hyperledger Fabric.

Link to this function

list_members(client, network_id, is_owned \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

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

Applies only to Hyperledger Fabric.

Link to this function

list_networks(client, framework \\ nil, max_results \\ nil, name \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

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

Applies to Hyperledger Fabric and Ethereum.

Link to this function

list_nodes(client, network_id, max_results \\ nil, member_id \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

Link to this function

list_proposal_votes(client, network_id, proposal_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_proposals(client, network_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of proposals for the network.

Applies only to Hyperledger Fabric.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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.

Link to this function

reject_invitation(client, invitation_id, input, options \\ [])

View Source

Rejects an invitation to join a network.

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

Applies only to Hyperledger Fabric.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

update_member(client, member_id, network_id, input, options \\ [])

View Source

Updates a member configuration with new parameters.

Applies only to Hyperledger Fabric.

Link to this function

update_node(client, network_id, node_id, input, options \\ [])

View Source

Updates a node configuration with new parameters.

Applies only to Hyperledger Fabric.

Link to this function

vote_on_proposal(client, network_id, proposal_id, input, options \\ [])

View Source

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 AWS account as the principal that calls the action.

Applies only to Hyperledger Fabric.