ManagedBlockchain

public struct ManagedBlockchain

Client object for interacting with AWS ManagedBlockchain service.

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.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the ManagedBlockchain client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    createMember(_:)

Creates a member within a Managed Blockchain network.

Declaration

Swift

public func createMember(_ input: CreateMemberInput) -> EventLoopFuture<CreateMemberOutput>


                    
                    
                    createNetwork(_:)

Creates a new blockchain network using Amazon Managed Blockchain.

Declaration

Swift

public func createNetwork(_ input: CreateNetworkInput) -> EventLoopFuture<CreateNetworkOutput>


                    
                    
                    createNode(_:)

Creates a peer node in a member.

Declaration

Swift

public func createNode(_ input: CreateNodeInput) -> EventLoopFuture<CreateNodeOutput>

createProposal(_:)
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.
Declaration
Swift

public func createProposal(_ input: CreateProposalInput) -> EventLoopFuture<CreateProposalOutput>
deleteMember(_:)
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.
Declaration
Swift

public func deleteMember(_ input: DeleteMemberInput) -> EventLoopFuture<DeleteMemberOutput>
deleteNode(_:)
Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.
Declaration
Swift

public func deleteNode(_ input: DeleteNodeInput) -> EventLoopFuture<DeleteNodeOutput>


                    
                    
                    getMember(_:)

Returns detailed information about a member.

Declaration

Swift

public func getMember(_ input: GetMemberInput) -> EventLoopFuture<GetMemberOutput>


                    
                    
                    getNetwork(_:)

Returns detailed information about a network.

Declaration

Swift

public func getNetwork(_ input: GetNetworkInput) -> EventLoopFuture<GetNetworkOutput>


                    
                    
                    getNode(_:)

Returns detailed information about a peer node.

Declaration

Swift

public func getNode(_ input: GetNodeInput) -> EventLoopFuture<GetNodeOutput>


                    
                    
                    getProposal(_:)

Returns detailed information about a proposal.

Declaration

Swift

public func getProposal(_ input: GetProposalInput) -> EventLoopFuture<GetProposalOutput>


                    
                    
                    listInvitations(_:)

Returns a listing of all invitations made on the specified network.

Declaration

Swift

public func listInvitations(_ input: ListInvitationsInput) -> EventLoopFuture<ListInvitationsOutput>

listMembers(_:)
Returns a listing of the members in a network and properties of their configurations.
Declaration
Swift

public func listMembers(_ input: ListMembersInput) -> EventLoopFuture<ListMembersOutput>
listNetworks(_:)
Returns information about the networks in which the current AWS account has members.
Declaration
Swift

public func listNetworks(_ input: ListNetworksInput) -> EventLoopFuture<ListNetworksOutput>


                    
                    
                    listNodes(_:)

Returns information about the nodes within a network.

Declaration

Swift

public func listNodes(_ input: ListNodesInput) -> EventLoopFuture<ListNodesOutput>

listProposalVotes(_:)
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.
Declaration
Swift

public func listProposalVotes(_ input: ListProposalVotesInput) -> EventLoopFuture<ListProposalVotesOutput>


                    
                    
                    listProposals(_:)

Returns a listing of proposals for the network.

Declaration

Swift

public func listProposals(_ input: ListProposalsInput) -> EventLoopFuture<ListProposalsOutput>

rejectInvitation(_:)
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.
Declaration
Swift

public func rejectInvitation(_ input: RejectInvitationInput) -> EventLoopFuture<RejectInvitationOutput>


                    
                    
                    updateMember(_:)

Updates a member configuration with new parameters.

Declaration

Swift

public func updateMember(_ input: UpdateMemberInput) -> EventLoopFuture<UpdateMemberOutput>


                    
                    
                    updateNode(_:)

Updates a node configuration with new parameters.

Declaration

Swift

public func updateNode(_ input: UpdateNodeInput) -> EventLoopFuture<UpdateNodeOutput>

voteOnProposal(_:)
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.
Declaration
Swift

public func voteOnProposal(_ input: VoteOnProposalInput) -> EventLoopFuture<VoteOnProposalOutput>

Paginators


                    
                    
                    listInvitationsPaginator(_:onPage:)

Returns a listing of all invitations made on the specified network.

Declaration

Swift

public func listInvitationsPaginator(_ input: ListInvitationsInput, onPage: @escaping (ListInvitationsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listMembersPaginator(_:onPage:)

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

Declaration

Swift

public func listMembersPaginator(_ input: ListMembersInput, onPage: @escaping (ListMembersOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listNetworksPaginator(_:onPage:)

Returns information about the networks in which the current AWS account has members.

Declaration

Swift

public func listNetworksPaginator(_ input: ListNetworksInput, onPage: @escaping (ListNetworksOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listNodesPaginator(_:onPage:)

Returns information about the nodes within a network.

Declaration

Swift

public func listNodesPaginator(_ input: ListNodesInput, onPage: @escaping (ListNodesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

listProposalVotesPaginator(_:onPage:)
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.
Declaration
Swift

public func listProposalVotesPaginator(_ input: ListProposalVotesInput, onPage: @escaping (ListProposalVotesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listProposalsPaginator(_:onPage:)

Returns a listing of proposals for the network.

Declaration

Swift

public func listProposalsPaginator(_ input: ListProposalsInput, onPage: @escaping (ListProposalsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListInvitationsInput

Undocumented

Declaration

Swift

public struct ListInvitationsInput : AWSShape

extension ManagedBlockchain.ListInvitationsInput: AWSPaginateStringToken


                    
                    
                    ListMembersInput

Undocumented

Declaration

Swift

public struct ListMembersInput : AWSShape

extension ManagedBlockchain.ListMembersInput: AWSPaginateStringToken


                    
                    
                    ListNetworksInput

Undocumented

Declaration

Swift

public struct ListNetworksInput : AWSShape

extension ManagedBlockchain.ListNetworksInput: AWSPaginateStringToken


                    
                    
                    ListNodesInput

Undocumented

Declaration

Swift

public struct ListNodesInput : AWSShape

extension ManagedBlockchain.ListNodesInput: AWSPaginateStringToken


                    
                    
                    ListProposalVotesInput

Undocumented

Declaration

Swift

public struct ListProposalVotesInput : AWSShape

extension ManagedBlockchain.ListProposalVotesInput: AWSPaginateStringToken


                    
                    
                    ListProposalsInput

Undocumented

Declaration

Swift

public struct ListProposalsInput : AWSShape

extension ManagedBlockchain.ListProposalsInput: AWSPaginateStringToken

ApprovalThresholdPolicy
Undocumented
See more
Declaration
Swift

public struct ApprovalThresholdPolicy : AWSShape
CreateMemberInput
Undocumented
See more
Declaration
Swift

public struct CreateMemberInput : AWSShape
CreateMemberOutput
Undocumented
See more
Declaration
Swift

public struct CreateMemberOutput : AWSShape
CreateNetworkInput
Undocumented
See more
Declaration
Swift

public struct CreateNetworkInput : AWSShape
CreateNetworkOutput
Undocumented
See more
Declaration
Swift

public struct CreateNetworkOutput : AWSShape
CreateNodeInput
Undocumented
See more
Declaration
Swift

public struct CreateNodeInput : AWSShape
CreateNodeOutput
Undocumented
See more
Declaration
Swift

public struct CreateNodeOutput : AWSShape
CreateProposalInput
Undocumented
See more
Declaration
Swift

public struct CreateProposalInput : AWSShape
CreateProposalOutput
Undocumented
See more
Declaration
Swift

public struct CreateProposalOutput : AWSShape
DeleteMemberInput
Undocumented
See more
Declaration
Swift

public struct DeleteMemberInput : AWSShape
DeleteMemberOutput
Undocumented
See more
Declaration
Swift

public struct DeleteMemberOutput : AWSShape
DeleteNodeInput
Undocumented
See more
Declaration
Swift

public struct DeleteNodeInput : AWSShape
DeleteNodeOutput
Undocumented
See more
Declaration
Swift

public struct DeleteNodeOutput : AWSShape
GetMemberInput
Undocumented
See more
Declaration
Swift

public struct GetMemberInput : AWSShape
GetMemberOutput
Undocumented
See more
Declaration
Swift

public struct GetMemberOutput : AWSShape
GetNetworkInput
Undocumented
See more
Declaration
Swift

public struct GetNetworkInput : AWSShape
GetNetworkOutput
Undocumented
See more
Declaration
Swift

public struct GetNetworkOutput : AWSShape
GetNodeInput
Undocumented
See more
Declaration
Swift

public struct GetNodeInput : AWSShape
GetNodeOutput
Undocumented
See more
Declaration
Swift

public struct GetNodeOutput : AWSShape
GetProposalInput
Undocumented
See more
Declaration
Swift

public struct GetProposalInput : AWSShape
GetProposalOutput
Undocumented
See more
Declaration
Swift

public struct GetProposalOutput : AWSShape
Invitation
Undocumented
See more
Declaration
Swift

public struct Invitation : AWSShape
InviteAction
Undocumented
See more
Declaration
Swift

public struct InviteAction : AWSShape
ListInvitationsOutput
Undocumented
See more
Declaration
Swift

public struct ListInvitationsOutput : AWSShape
ListMembersOutput
Undocumented
See more
Declaration
Swift

public struct ListMembersOutput : AWSShape
ListNetworksOutput
Undocumented
See more
Declaration
Swift

public struct ListNetworksOutput : AWSShape
ListNodesOutput
Undocumented
See more
Declaration
Swift

public struct ListNodesOutput : AWSShape
ListProposalVotesOutput
Undocumented
See more
Declaration
Swift

public struct ListProposalVotesOutput : AWSShape
ListProposalsOutput
Undocumented
See more
Declaration
Swift

public struct ListProposalsOutput : AWSShape
LogConfiguration
Undocumented
See more
Declaration
Swift

public struct LogConfiguration : AWSShape
LogConfigurations
Undocumented
See more
Declaration
Swift

public struct LogConfigurations : AWSShape
Member
Undocumented
See more
Declaration
Swift

public struct Member : AWSShape
MemberConfiguration
Undocumented
See more
Declaration
Swift

public struct MemberConfiguration : AWSShape
MemberFabricAttributes
Undocumented
See more
Declaration
Swift

public struct MemberFabricAttributes : AWSShape
MemberFabricConfiguration
Undocumented
See more
Declaration
Swift

public struct MemberFabricConfiguration : AWSShape
MemberFabricLogPublishingConfiguration
Undocumented
See more
Declaration
Swift

public struct MemberFabricLogPublishingConfiguration : AWSShape
MemberFrameworkAttributes
Undocumented
See more
Declaration
Swift

public struct MemberFrameworkAttributes : AWSShape
MemberFrameworkConfiguration
Undocumented
See more
Declaration
Swift

public struct MemberFrameworkConfiguration : AWSShape
MemberLogPublishingConfiguration
Undocumented
See more
Declaration
Swift

public struct MemberLogPublishingConfiguration : AWSShape
MemberSummary
Undocumented
See more
Declaration
Swift

public struct MemberSummary : AWSShape
Network
Undocumented
See more
Declaration
Swift

public struct Network : AWSShape
NetworkFabricAttributes
Undocumented
See more
Declaration
Swift

public struct NetworkFabricAttributes : AWSShape
NetworkFabricConfiguration
Undocumented
See more
Declaration
Swift

public struct NetworkFabricConfiguration : AWSShape
NetworkFrameworkAttributes
Undocumented
See more
Declaration
Swift

public struct NetworkFrameworkAttributes : AWSShape
NetworkFrameworkConfiguration
Undocumented
See more
Declaration
Swift

public struct NetworkFrameworkConfiguration : AWSShape
NetworkSummary
Undocumented
See more
Declaration
Swift

public struct NetworkSummary : AWSShape
Node
Undocumented
See more
Declaration
Swift

public struct Node : AWSShape
NodeConfiguration
Undocumented
See more
Declaration
Swift

public struct NodeConfiguration : AWSShape
NodeFabricAttributes
Undocumented
See more
Declaration
Swift

public struct NodeFabricAttributes : AWSShape
NodeFabricLogPublishingConfiguration
Undocumented
See more
Declaration
Swift

public struct NodeFabricLogPublishingConfiguration : AWSShape
NodeFrameworkAttributes
Undocumented
See more
Declaration
Swift

public struct NodeFrameworkAttributes : AWSShape
NodeLogPublishingConfiguration
Undocumented
See more
Declaration
Swift

public struct NodeLogPublishingConfiguration : AWSShape
NodeSummary
Undocumented
See more
Declaration
Swift

public struct NodeSummary : AWSShape
Proposal
Undocumented
See more
Declaration
Swift

public struct Proposal : AWSShape
ProposalActions
Undocumented
See more
Declaration
Swift

public struct ProposalActions : AWSShape
ProposalSummary
Undocumented
See more
Declaration
Swift

public struct ProposalSummary : AWSShape
RejectInvitationInput
Undocumented
See more
Declaration
Swift

public struct RejectInvitationInput : AWSShape
RejectInvitationOutput
Undocumented
See more
Declaration
Swift

public struct RejectInvitationOutput : AWSShape
RemoveAction
Undocumented
See more
Declaration
Swift

public struct RemoveAction : AWSShape
UpdateMemberInput
Undocumented
See more
Declaration
Swift

public struct UpdateMemberInput : AWSShape
UpdateMemberOutput
Undocumented
See more
Declaration
Swift

public struct UpdateMemberOutput : AWSShape
UpdateNodeInput
Undocumented
See more
Declaration
Swift

public struct UpdateNodeInput : AWSShape
UpdateNodeOutput
Undocumented
See more
Declaration
Swift

public struct UpdateNodeOutput : AWSShape
VoteOnProposalInput
Undocumented
See more
Declaration
Swift

public struct VoteOnProposalInput : AWSShape
VoteOnProposalOutput
Undocumented
See more
Declaration
Swift

public struct VoteOnProposalOutput : AWSShape
VoteSummary
Undocumented
See more
Declaration
Swift

public struct VoteSummary : AWSShape
VotingPolicy
Undocumented
See more
Declaration
Swift

public struct VotingPolicy : AWSShape

Enums


                    
                    
                    Edition

Undocumented

Declaration

Swift

public enum Edition : String, CustomStringConvertible, Codable


                    
                    
                    Framework

Undocumented

Declaration

Swift

public enum Framework : String, CustomStringConvertible, Codable


                    
                    
                    InvitationStatus

Undocumented

Declaration

Swift

public enum InvitationStatus : String, CustomStringConvertible, Codable


                    
                    
                    MemberStatus

Undocumented

Declaration

Swift

public enum MemberStatus : String, CustomStringConvertible, Codable


                    
                    
                    NetworkStatus

Undocumented

Declaration

Swift

public enum NetworkStatus : String, CustomStringConvertible, Codable


                    
                    
                    NodeStatus

Undocumented

Declaration

Swift

public enum NodeStatus : String, CustomStringConvertible, Codable


                    
                    
                    ProposalStatus

Undocumented

Declaration

Swift

public enum ProposalStatus : String, CustomStringConvertible, Codable


                    
                    
                    ThresholdComparator

Undocumented

Declaration

Swift

public enum ThresholdComparator : String, CustomStringConvertible, Codable


                    
                    
                    VoteValue

Undocumented

Declaration

Swift

public enum VoteValue : String, CustomStringConvertible, Codable