AmazonManagedBlockchain (AWS SDK for Java

All Known Subinterfaces:

AmazonManagedBlockchainAsync

All Known Implementing Classes:

AbstractAmazonManagedBlockchain, AbstractAmazonManagedBlockchainAsync, AmazonManagedBlockchainAsyncClient, AmazonManagedBlockchainClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonManagedBlockchain
```
Interface for accessing ManagedBlockchain.
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. Currently, Managed Blockchain supports the Hyperledger Fabric open source framework.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
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 peer node in a member.
`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 peer node from a member 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 peer node.
`GetProposalResult`	`getProposal(GetProposalRequest getProposalRequest)` Returns detailed information about a proposal.
`ListInvitationsResult`	`listInvitations(ListInvitationsRequest listInvitationsRequest)` Returns a listing of all invitations made on the specified network.
`ListMembersResult`	`listMembers(ListMembersRequest listMembersRequest)` Returns a listing 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 has members.
`ListNodesResult`	`listNodes(ListNodesRequest listNodesRequest)` Returns information about the nodes within a network.
`ListProposalsResult`	`listProposals(ListProposalsRequest listProposalsRequest)` Returns a listing of proposals for the network.
`ListProposalVotesResult`	`listProposalVotes(ListProposalVotesRequest listProposalVotesRequest)` Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.
`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.
`VoteOnProposalResult`	`voteOnProposal(VoteOnProposalRequest voteOnProposalRequest)` Casts a vote for a specified `ProposalId` on behalf of a member.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createMember
```
CreateMemberResult createMember(CreateMemberRequest createMemberRequest)
```
    Creates a member within a Managed Blockchain network.
    
    Parameters:
    
    createMemberRequest -
    
    Returns:
    
    Result of the CreateMember operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - createNetwork
```
CreateNetworkResult createNetwork(CreateNetworkRequest createNetworkRequest)
```
    Creates a new blockchain network using Amazon Managed Blockchain.
    
    Parameters:
    
    createNetworkRequest -
    
    Returns:
    
    Result of the CreateNetwork operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createNode
```
CreateNodeResult createNode(CreateNodeRequest createNodeRequest)
```
    Creates a peer node in a member.
    
    Parameters:
    
    createNodeRequest -
    
    Returns:
    
    Result of the CreateNode operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - createProposal
```
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.
    
    Parameters:
    
    createProposalRequest -
    
    Returns:
    
    Result of the CreateProposal operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - deleteMember
```
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.
    
    Parameters:
    
    deleteMemberRequest -
    
    Returns:
    
    Result of the DeleteMember operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - deleteNode
```
DeleteNodeResult deleteNode(DeleteNodeRequest deleteNodeRequest)
```
    Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.
    
    Parameters:
    
    deleteNodeRequest -
    
    Returns:
    
    Result of the DeleteNode operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - getMember
```
GetMemberResult getMember(GetMemberRequest getMemberRequest)
```
    Returns detailed information about a member.
    
    Parameters:
    
    getMemberRequest -
    
    Returns:
    
    Result of the GetMember operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - getNetwork
```
GetNetworkResult getNetwork(GetNetworkRequest getNetworkRequest)
```
    Returns detailed information about a network.
    
    Parameters:
    
    getNetworkRequest -
    
    Returns:
    
    Result of the GetNetwork operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - getNode
```
GetNodeResult getNode(GetNodeRequest getNodeRequest)
```
    Returns detailed information about a peer node.
    
    Parameters:
    
    getNodeRequest -
    
    Returns:
    
    Result of the GetNode operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - getProposal
```
GetProposalResult getProposal(GetProposalRequest getProposalRequest)
```
    Returns detailed information about a proposal.
    
    Parameters:
    
    getProposalRequest -
    
    Returns:
    
    Result of the GetProposal operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - listInvitations
```
ListInvitationsResult listInvitations(ListInvitationsRequest listInvitationsRequest)
```
    Returns a listing of all invitations made on the specified network.
    
    Parameters:
    
    listInvitationsRequest -
    
    Returns:
    
    Result of the ListInvitations operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - listMembers
```
ListMembersResult listMembers(ListMembersRequest listMembersRequest)
```
    Returns a listing of the members in a network and properties of their configurations.
    
    Parameters:
    
    listMembersRequest -
    
    Returns:
    
    Result of the ListMembers operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listNetworks
```
ListNetworksResult listNetworks(ListNetworksRequest listNetworksRequest)
```
    Returns information about the networks in which the current AWS account has members.
    
    Parameters:
    
    listNetworksRequest -
    
    Returns:
    
    Result of the ListNetworks operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listNodes
```
ListNodesResult listNodes(ListNodesRequest listNodesRequest)
```
    Returns information about the nodes within a network.
    
    Parameters:
    
    listNodesRequest -
    
    Returns:
    
    Result of the ListNodes operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listProposalVotes
```
ListProposalVotesResult listProposalVotes(ListProposalVotesRequest listProposalVotesRequest)
```
    Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.
    
    Parameters:
    
    listProposalVotesRequest -
    
    Returns:
    
    Result of the ListProposalVotes operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listProposals
```
ListProposalsResult listProposals(ListProposalsRequest listProposalsRequest)
```
    Returns a listing of proposals for the network.
    
    Parameters:
    
    listProposalsRequest -
    
    Returns:
    
    Result of the ListProposals operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The action or operation requested is invalid. Verify that the action is typed correctly.
    
    ResourceNotFoundException - A requested resource does not exist on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - rejectInvitation
```
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.
    
    Parameters:
    
    rejectInvitationRequest -
    
    Returns:
    
    Result of the RejectInvitation operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - voteOnProposal
```
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.
    
    Parameters:
    
    voteOnProposalRequest -
    
    Returns:
    
    Result of the VoteOnProposal operation returned by the service.
    
    Throws:
    
    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 on the network. 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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonManagedBlockchain

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createMember

createNetwork

createNode

createProposal

deleteMember

deleteNode

getMember

getNetwork

getNode

getProposal

listInvitations

listMembers

listNetworks

listNodes

listProposalVotes

listProposals

rejectInvitation

voteOnProposal

shutdown

getCachedResponseMetadata