@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonManagedBlockchain
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonManagedBlockchain
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateMemberResult |
createMember(CreateMemberRequest createMemberRequest)
Creates a member within a Managed Blockchain network.
|
CreateNetworkResult |
createNetwork(CreateNetworkRequest createNetworkRequest)
Creates a new blockchain network using Amazon Managed Blockchain.
|
CreateNodeResult |
createNode(CreateNodeRequest createNodeRequest)
Creates a node on the specified blockchain network.
|
CreateProposalResult |
createProposal(CreateProposalRequest createProposalRequest)
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.
|
DeleteMemberResult |
deleteMember(DeleteMemberRequest deleteMemberRequest)
Deletes a member.
|
DeleteNodeResult |
deleteNode(DeleteNodeRequest deleteNodeRequest)
Deletes a node that your AWS account owns.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetMemberResult |
getMember(GetMemberRequest getMemberRequest)
Returns detailed information about a member.
|
GetNetworkResult |
getNetwork(GetNetworkRequest getNetworkRequest)
Returns detailed information about a network.
|
GetNodeResult |
getNode(GetNodeRequest getNodeRequest)
Returns detailed information about a node.
|
GetProposalResult |
getProposal(GetProposalRequest getProposalRequest)
Returns detailed information about a proposal.
|
ListInvitationsResult |
listInvitations(ListInvitationsRequest listInvitationsRequest)
Returns a list of all invitations for the current AWS account.
|
ListMembersResult |
listMembers(ListMembersRequest listMembersRequest)
Returns a list of the members in a network and properties of their configurations.
|
ListNetworksResult |
listNetworks(ListNetworksRequest listNetworksRequest)
Returns information about the networks in which the current AWS account participates.
|
ListNodesResult |
listNodes(ListNodesRequest listNodesRequest)
Returns information about the nodes within a network.
|
ListProposalsResult |
listProposals(ListProposalsRequest listProposalsRequest)
Returns a list of proposals for the network.
|
ListProposalVotesResult |
listProposalVotes(ListProposalVotesRequest listProposalVotesRequest)
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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for the specified resource.
|
RejectInvitationResult |
rejectInvitation(RejectInvitationRequest rejectInvitationRequest)
Rejects an invitation to join a network.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the Amazon Managed Blockchain resource.
|
UpdateMemberResult |
updateMember(UpdateMemberRequest updateMemberRequest)
Updates a member configuration with new parameters.
|
UpdateNodeResult |
updateNode(UpdateNodeRequest updateNodeRequest)
Updates a node configuration with new parameters.
|
VoteOnProposalResult |
voteOnProposal(VoteOnProposalRequest voteOnProposalRequest)
Casts a vote for a specified
ProposalId on behalf of a member. |
static final String ENDPOINT_PREFIX
CreateMemberResult createMember(CreateMemberRequest createMemberRequest)
Creates a member within a Managed Blockchain network.
Applies only to Hyperledger Fabric.
createMemberRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.ResourceAlreadyExistsException
- A resource request is issued for a resource that already exists.ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.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.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.TooManyTagsException
CreateNetworkResult createNetwork(CreateNetworkRequest createNetworkRequest)
Creates a new blockchain network using Amazon Managed Blockchain.
Applies only to Hyperledger Fabric.
createNetworkRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceAlreadyExistsException
- A resource request is issued for a resource that already exists.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.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.TooManyTagsException
CreateNodeResult createNode(CreateNodeRequest createNodeRequest)
Creates a node on the specified blockchain network.
Applies to Hyperledger Fabric and Ethereum.
createNodeRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.ResourceAlreadyExistsException
- A resource request is issued for a resource that already exists.ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.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.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.TooManyTagsException
CreateProposalResult createProposal(CreateProposalRequest createProposalRequest)
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.
createProposalRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.TooManyTagsException
DeleteMemberResult deleteMember(DeleteMemberRequest deleteMemberRequest)
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.
deleteMemberRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.DeleteNodeResult deleteNode(DeleteNodeRequest deleteNodeRequest)
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.
deleteNodeRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.GetMemberResult getMember(GetMemberRequest getMemberRequest)
Returns detailed information about a member.
Applies only to Hyperledger Fabric.
getMemberRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.GetNetworkResult getNetwork(GetNetworkRequest getNetworkRequest)
Returns detailed information about a network.
Applies to Hyperledger Fabric and Ethereum.
getNetworkRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.GetNodeResult getNode(GetNodeRequest getNodeRequest)
Returns detailed information about a node.
Applies to Hyperledger Fabric and Ethereum.
getNodeRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.GetProposalResult getProposal(GetProposalRequest getProposalRequest)
Returns detailed information about a proposal.
Applies only to Hyperledger Fabric.
getProposalRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.ListInvitationsResult listInvitations(ListInvitationsRequest listInvitationsRequest)
Returns a list of all invitations for the current AWS account.
Applies only to Hyperledger Fabric.
listInvitationsRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.ListMembersResult listMembers(ListMembersRequest listMembersRequest)
Returns a list of the members in a network and properties of their configurations.
Applies only to Hyperledger Fabric.
listMembersRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.ListNetworksResult listNetworks(ListNetworksRequest listNetworksRequest)
Returns information about the networks in which the current AWS account participates.
Applies to Hyperledger Fabric and Ethereum.
listNetworksRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.ListNodesResult listNodes(ListNodesRequest listNodesRequest)
Returns information about the nodes within a network.
Applies to Hyperledger Fabric and Ethereum.
listNodesRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.ListProposalVotesResult listProposalVotes(ListProposalVotesRequest listProposalVotesRequest)
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.
listProposalVotesRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.ListProposalsResult listProposals(ListProposalsRequest listProposalsRequest)
Returns a list of proposals for the network.
Applies only to Hyperledger Fabric.
listProposalsRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.AccessDeniedException
- You do not have sufficient access to perform this action.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest
- InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.RejectInvitationResult rejectInvitation(RejectInvitationRequest rejectInvitationRequest)
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.
rejectInvitationRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.IllegalActionException
AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.TooManyTagsException
ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest
- InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.ResourceNotReadyException
- The requested resource exists but is not in a status that can complete the operation.UpdateMemberResult updateMember(UpdateMemberRequest updateMemberRequest)
Updates a member configuration with new parameters.
Applies only to Hyperledger Fabric.
updateMemberRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.UpdateNodeResult updateNode(UpdateNodeRequest updateNodeRequest)
Updates a node configuration with new parameters.
Applies only to Hyperledger Fabric.
updateNodeRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.VoteOnProposalResult voteOnProposal(VoteOnProposalRequest voteOnProposalRequest)
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.
voteOnProposalRequest
- InvalidRequestException
- The action or operation requested is invalid. Verify that the action is typed correctly.IllegalActionException
AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- A requested resource does not exist. It may have been deleted or referenced inaccurately.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.InternalServiceErrorException
- The request processing has failed because of an unknown error, exception or failure.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.