managedblockchain/aws.sdk.kotlin.services.managedblockchain

Package-level declarations

Types

interface ManagedBlockchainClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createAccessor

inline suspend fun ManagedBlockchainClient.createAccessor(crossinline block: CreateAccessorRequest.Builder.() -> Unit): CreateAccessorResponse

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.

createMember

inline suspend fun ManagedBlockchainClient.createMember(crossinline block: CreateMemberRequest.Builder.() -> Unit): CreateMemberResponse

Creates a member within a Managed Blockchain network.

createNetwork

inline suspend fun ManagedBlockchainClient.createNetwork(crossinline block: CreateNetworkRequest.Builder.() -> Unit): CreateNetworkResponse

Creates a new blockchain network using Amazon Managed Blockchain.

createNode

inline suspend fun ManagedBlockchainClient.createNode(crossinline block: CreateNodeRequest.Builder.() -> Unit): CreateNodeResponse

Creates a node on the specified blockchain network.

createProposal

inline suspend fun ManagedBlockchainClient.createProposal(crossinline block: CreateProposalRequest.Builder.() -> Unit): CreateProposalResponse

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.

deleteAccessor

inline suspend fun ManagedBlockchainClient.deleteAccessor(crossinline block: DeleteAccessorRequest.Builder.() -> Unit): DeleteAccessorResponse

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).

deleteMember

inline suspend fun ManagedBlockchainClient.deleteMember(crossinline block: DeleteMemberRequest.Builder.() -> Unit): DeleteMemberResponse

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.

deleteNode

inline suspend fun ManagedBlockchainClient.deleteNode(crossinline block: DeleteNodeRequest.Builder.() -> Unit): DeleteNodeResponse

Deletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered.

getAccessor

inline suspend fun ManagedBlockchainClient.getAccessor(crossinline block: GetAccessorRequest.Builder.() -> Unit): GetAccessorResponse

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.

getMember

inline suspend fun ManagedBlockchainClient.getMember(crossinline block: GetMemberRequest.Builder.() -> Unit): GetMemberResponse

Returns detailed information about a member.

getNetwork

inline suspend fun ManagedBlockchainClient.getNetwork(crossinline block: GetNetworkRequest.Builder.() -> Unit): GetNetworkResponse

Returns detailed information about a network.

getNode

inline suspend fun ManagedBlockchainClient.getNode(crossinline block: GetNodeRequest.Builder.() -> Unit): GetNodeResponse

Returns detailed information about a node.

getProposal

inline suspend fun ManagedBlockchainClient.getProposal(crossinline block: GetProposalRequest.Builder.() -> Unit): GetProposalResponse

Returns detailed information about a proposal.

listAccessors

inline suspend fun ManagedBlockchainClient.listAccessors(crossinline block: ListAccessorsRequest.Builder.() -> Unit): ListAccessorsResponse

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.

listInvitations

inline suspend fun ManagedBlockchainClient.listInvitations(crossinline block: ListInvitationsRequest.Builder.() -> Unit): ListInvitationsResponse

Returns a list of all invitations for the current Amazon Web Services account.

listMembers

inline suspend fun ManagedBlockchainClient.listMembers(crossinline block: ListMembersRequest.Builder.() -> Unit): ListMembersResponse

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

listNetworks

inline suspend fun ManagedBlockchainClient.listNetworks(crossinline block: ListNetworksRequest.Builder.() -> Unit): ListNetworksResponse

Returns information about the networks in which the current Amazon Web Services account participates.

listNodes

inline suspend fun ManagedBlockchainClient.listNodes(crossinline block: ListNodesRequest.Builder.() -> Unit): ListNodesResponse

Returns information about the nodes within a network.

listProposals

inline suspend fun ManagedBlockchainClient.listProposals(crossinline block: ListProposalsRequest.Builder.() -> Unit): ListProposalsResponse

Returns a list of proposals for the network.

listProposalVotes

inline suspend fun ManagedBlockchainClient.listProposalVotes(crossinline block: ListProposalVotesRequest.Builder.() -> Unit): ListProposalVotesResponse

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.

listTagsForResource

inline suspend fun ManagedBlockchainClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of tags for the specified resource. Each tag consists of a key and optional value.

rejectInvitation

inline suspend fun ManagedBlockchainClient.rejectInvitation(crossinline block: RejectInvitationRequest.Builder.() -> Unit): RejectInvitationResponse

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.

tagResource

inline suspend fun ManagedBlockchainClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value.

untagResource

inline suspend fun ManagedBlockchainClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the Amazon Managed Blockchain resource.

updateMember

inline suspend fun ManagedBlockchainClient.updateMember(crossinline block: UpdateMemberRequest.Builder.() -> Unit): UpdateMemberResponse

Updates a member configuration with new parameters.

updateNode

inline suspend fun ManagedBlockchainClient.updateNode(crossinline block: UpdateNodeRequest.Builder.() -> Unit): UpdateNodeResponse

Updates a node configuration with new parameters.

voteOnProposal

inline suspend fun ManagedBlockchainClient.voteOnProposal(crossinline block: VoteOnProposalRequest.Builder.() -> Unit): VoteOnProposalResponse

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.

withConfig

fun ManagedBlockchainClient.withConfig(block: ManagedBlockchainClient.Config.Builder.() -> Unit): ManagedBlockchainClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.