Class: Aws::ManagedBlockchain::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ManagedBlockchain::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb
Overview
An API client for ManagedBlockchain. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ManagedBlockchain::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_accessor(params = {}) ⇒ Types::CreateAccessorOutput
Creates a new accessor for use with Amazon Managed Blockchain service that supports token based access.
-
#create_member(params = {}) ⇒ Types::CreateMemberOutput
Creates a member within a Managed Blockchain network.
-
#create_network(params = {}) ⇒ Types::CreateNetworkOutput
Creates a new blockchain network using Amazon Managed Blockchain.
-
#create_node(params = {}) ⇒ Types::CreateNodeOutput
Creates a node on the specified blockchain network.
-
#create_proposal(params = {}) ⇒ Types::CreateProposalOutput
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.
-
#delete_accessor(params = {}) ⇒ Struct
Deletes an accessor that your Amazon Web Services account owns.
-
#delete_member(params = {}) ⇒ Struct
Deletes a member.
-
#delete_node(params = {}) ⇒ Struct
Deletes a node that your Amazon Web Services account owns.
-
#get_accessor(params = {}) ⇒ Types::GetAccessorOutput
Returns detailed information about an accessor.
-
#get_member(params = {}) ⇒ Types::GetMemberOutput
Returns detailed information about a member.
-
#get_network(params = {}) ⇒ Types::GetNetworkOutput
Returns detailed information about a network.
-
#get_node(params = {}) ⇒ Types::GetNodeOutput
Returns detailed information about a node.
-
#get_proposal(params = {}) ⇒ Types::GetProposalOutput
Returns detailed information about a proposal.
-
#list_accessors(params = {}) ⇒ Types::ListAccessorsOutput
Returns a list of the accessors and their properties.
-
#list_invitations(params = {}) ⇒ Types::ListInvitationsOutput
Returns a list of all invitations for the current Amazon Web Services account.
-
#list_members(params = {}) ⇒ Types::ListMembersOutput
Returns a list of the members in a network and properties of their configurations.
-
#list_networks(params = {}) ⇒ Types::ListNetworksOutput
Returns information about the networks in which the current Amazon Web Services account participates.
-
#list_nodes(params = {}) ⇒ Types::ListNodesOutput
Returns information about the nodes within a network.
-
#list_proposal_votes(params = {}) ⇒ Types::ListProposalVotesOutput
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.
-
#list_proposals(params = {}) ⇒ Types::ListProposalsOutput
Returns a list of proposals for the network.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for the specified resource.
-
#reject_invitation(params = {}) ⇒ Struct
Rejects an invitation to join a network.
-
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the Amazon Managed Blockchain resource.
-
#update_member(params = {}) ⇒ Struct
Updates a member configuration with new parameters.
-
#update_node(params = {}) ⇒ Struct
Updates a node configuration with new parameters.
-
#vote_on_proposal(params = {}) ⇒ Struct
Casts a vote for a specified
ProposalId
on behalf of a member.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_accessor(params = {}) ⇒ Types::CreateAccessorOutput
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.
498 499 500 501 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 498 def create_accessor(params = {}, = {}) req = build_request(:create_accessor, params) req.send_request() end |
#create_member(params = {}) ⇒ Types::CreateMemberOutput
Creates a member within a Managed Blockchain network.
Applies only to Hyperledger Fabric.
570 571 572 573 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 570 def create_member(params = {}, = {}) req = build_request(:create_member, params) req.send_request() end |
#create_network(params = {}) ⇒ Types::CreateNetworkOutput
Creates a new blockchain network using Amazon Managed Blockchain.
Applies only to Hyperledger Fabric.
691 692 693 694 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 691 def create_network(params = {}, = {}) req = build_request(:create_network, params) req.send_request() end |
#create_node(params = {}) ⇒ Types::CreateNodeOutput
Creates a node on the specified blockchain network.
Applies to Hyperledger Fabric and Ethereum.
786 787 788 789 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 786 def create_node(params = {}, = {}) req = build_request(:create_node, params) req.send_request() end |
#create_proposal(params = {}) ⇒ Types::CreateProposalOutput
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.
879 880 881 882 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 879 def create_proposal(params = {}, = {}) req = build_request(:create_proposal, params) req.send_request() end |
#delete_accessor(params = {}) ⇒ Struct
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).
909 910 911 912 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 909 def delete_accessor(params = {}, = {}) req = build_request(:delete_accessor, params) req.send_request() end |
#delete_member(params = {}) ⇒ Struct
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.
944 945 946 947 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 944 def delete_member(params = {}, = {}) req = build_request(:delete_member, params) req.send_request() end |
#delete_node(params = {}) ⇒ Struct
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.
986 987 988 989 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 986 def delete_node(params = {}, = {}) req = build_request(:delete_node, params) req.send_request() end |
#get_accessor(params = {}) ⇒ Types::GetAccessorOutput
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.
1024 1025 1026 1027 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1024 def get_accessor(params = {}, = {}) req = build_request(:get_accessor, params) req.send_request() end |
#get_member(params = {}) ⇒ Types::GetMemberOutput
Returns detailed information about a member.
Applies only to Hyperledger Fabric.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1070 def get_member(params = {}, = {}) req = build_request(:get_member, params) req.send_request() end |
#get_network(params = {}) ⇒ Types::GetNetworkOutput
Returns detailed information about a network.
Applies to Hyperledger Fabric and Ethereum.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1116 def get_network(params = {}, = {}) req = build_request(:get_network, params) req.send_request() end |
#get_node(params = {}) ⇒ Types::GetNodeOutput
Returns detailed information about a node.
Applies to Hyperledger Fabric and Ethereum.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1174 def get_node(params = {}, = {}) req = build_request(:get_node, params) req.send_request() end |
#get_proposal(params = {}) ⇒ Types::GetProposalOutput
Returns detailed information about a proposal.
Applies only to Hyperledger Fabric.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1225 def get_proposal(params = {}, = {}) req = build_request(:get_proposal, params) req.send_request() end |
#list_accessors(params = {}) ⇒ Types::ListAccessorsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1280 def list_accessors(params = {}, = {}) req = build_request(:list_accessors, params) req.send_request() end |
#list_invitations(params = {}) ⇒ Types::ListInvitationsOutput
Returns a list of all invitations for the current Amazon Web Services account.
Applies only to Hyperledger Fabric.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1333 1334 1335 1336 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1333 def list_invitations(params = {}, = {}) req = build_request(:list_invitations, params) req.send_request() end |
#list_members(params = {}) ⇒ Types::ListMembersOutput
Returns a list of the members in a network and properties of their configurations.
Applies only to Hyperledger Fabric.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1400 def list_members(params = {}, = {}) req = build_request(:list_members, params) req.send_request() end |
#list_networks(params = {}) ⇒ Types::ListNetworksOutput
Returns information about the networks in which the current Amazon Web Services account participates.
Applies to Hyperledger Fabric and Ethereum.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1464 1465 1466 1467 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1464 def list_networks(params = {}, = {}) req = build_request(:list_networks, params) req.send_request() end |
#list_nodes(params = {}) ⇒ Types::ListNodesOutput
Returns information about the nodes within a network.
Applies to Hyperledger Fabric and Ethereum.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1525 def list_nodes(params = {}, = {}) req = build_request(:list_nodes, params) req.send_request() end |
#list_proposal_votes(params = {}) ⇒ Types::ListProposalVotesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1577 def list_proposal_votes(params = {}, = {}) req = build_request(:list_proposal_votes, params) req.send_request() end |
#list_proposals(params = {}) ⇒ Types::ListProposalsOutput
Returns a list of proposals for the network.
Applies only to Hyperledger Fabric.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1628 1629 1630 1631 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1628 def list_proposals(params = {}, = {}) req = build_request(:list_proposals, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1674 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#reject_invitation(params = {}) ⇒ Struct
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.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1700 def reject_invitation(params = {}, = {}) req = build_request(:reject_invitation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1755 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
1798 1799 1800 1801 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1798 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_member(params = {}) ⇒ Struct
Updates a member configuration with new parameters.
Applies only to Hyperledger Fabric.
1839 1840 1841 1842 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1839 def update_member(params = {}, = {}) req = build_request(:update_member, params) req.send_request() end |
#update_node(params = {}) ⇒ Struct
Updates a node configuration with new parameters.
Applies only to Hyperledger Fabric.
1890 1891 1892 1893 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1890 def update_node(params = {}, = {}) req = build_request(:update_node, params) req.send_request() end |
#vote_on_proposal(params = {}) ⇒ Struct
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.
1928 1929 1930 1931 |
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1928 def vote_on_proposal(params = {}, = {}) req = build_request(:vote_on_proposal, params) req.send_request() end |