managedblockchain – github.com/aws/aws-sdk-go-v2/service/managedblockchain Index | Files | Directories

package managedblockchain

import "github.com/aws/aws-sdk-go-v2/service/managedblockchain"

Package managedblockchain provides the API client, operations, and parameter types for Amazon Managed Blockchain.

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.

Index

Constants

const ServiceAPIVersion = "2018-09-24"
const ServiceID = "ManagedBlockchain"

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Managed Blockchain.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateMember

func (c *Client) CreateMember(ctx context.Context, params *CreateMemberInput, optFns ...func(*Options)) (*CreateMemberOutput, error)

Creates a member within a Managed Blockchain network.

func (*Client) CreateNetwork

func (c *Client) CreateNetwork(ctx context.Context, params *CreateNetworkInput, optFns ...func(*Options)) (*CreateNetworkOutput, error)

Creates a new blockchain network using Amazon Managed Blockchain.

func (*Client) CreateNode

func (c *Client) CreateNode(ctx context.Context, params *CreateNodeInput, optFns ...func(*Options)) (*CreateNodeOutput, error)

Creates a peer node in a member.

func (*Client) CreateProposal

func (c *Client) CreateProposal(ctx context.Context, params *CreateProposalInput, optFns ...func(*Options)) (*CreateProposalOutput, error)

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.

func (*Client) DeleteMember

func (c *Client) DeleteMember(ctx context.Context, params *DeleteMemberInput, optFns ...func(*Options)) (*DeleteMemberOutput, error)

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.

func (*Client) DeleteNode

func (c *Client) DeleteNode(ctx context.Context, params *DeleteNodeInput, optFns ...func(*Options)) (*DeleteNodeOutput, error)

Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.

func (*Client) GetMember

func (c *Client) GetMember(ctx context.Context, params *GetMemberInput, optFns ...func(*Options)) (*GetMemberOutput, error)

Returns detailed information about a member.

func (*Client) GetNetwork

func (c *Client) GetNetwork(ctx context.Context, params *GetNetworkInput, optFns ...func(*Options)) (*GetNetworkOutput, error)

Returns detailed information about a network.

func (*Client) GetNode

func (c *Client) GetNode(ctx context.Context, params *GetNodeInput, optFns ...func(*Options)) (*GetNodeOutput, error)

Returns detailed information about a peer node.

func (*Client) GetProposal

func (c *Client) GetProposal(ctx context.Context, params *GetProposalInput, optFns ...func(*Options)) (*GetProposalOutput, error)

Returns detailed information about a proposal.

func (*Client) ListInvitations

func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInput, optFns ...func(*Options)) (*ListInvitationsOutput, error)

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

func (*Client) ListMembers

func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error)

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

func (*Client) ListNetworks

func (c *Client) ListNetworks(ctx context.Context, params *ListNetworksInput, optFns ...func(*Options)) (*ListNetworksOutput, error)

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

func (*Client) ListNodes

func (c *Client) ListNodes(ctx context.Context, params *ListNodesInput, optFns ...func(*Options)) (*ListNodesOutput, error)

Returns information about the nodes within a network.

func (*Client) ListProposalVotes

func (c *Client) ListProposalVotes(ctx context.Context, params *ListProposalVotesInput, optFns ...func(*Options)) (*ListProposalVotesOutput, error)

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.

func (*Client) ListProposals

func (c *Client) ListProposals(ctx context.Context, params *ListProposalsInput, optFns ...func(*Options)) (*ListProposalsOutput, error)

Returns a listing of proposals for the network.

func (*Client) RejectInvitation

func (c *Client) RejectInvitation(ctx context.Context, params *RejectInvitationInput, optFns ...func(*Options)) (*RejectInvitationOutput, error)

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.

func (*Client) UpdateMember

func (c *Client) UpdateMember(ctx context.Context, params *UpdateMemberInput, optFns ...func(*Options)) (*UpdateMemberOutput, error)

Updates a member configuration with new parameters.

func (*Client) UpdateNode

func (c *Client) UpdateNode(ctx context.Context, params *UpdateNodeInput, optFns ...func(*Options)) (*UpdateNodeOutput, error)

Updates a node configuration with new parameters.

func (*Client) VoteOnProposal

func (c *Client) VoteOnProposal(ctx context.Context, params *VoteOnProposalInput, optFns ...func(*Options)) (*VoteOnProposalOutput, error)

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.

type CreateMemberInput

type CreateMemberInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time. This
	// identifier is required only if you make a service request directly using an HTTP
	// client. It is generated automatically if you use an AWS SDK or the AWS CLI.
	//
	// This member is required.
	ClientRequestToken *string

	// The unique identifier of the invitation that is sent to the member to join the
	// network.
	//
	// This member is required.
	InvitationId *string

	// Member configuration parameters.
	//
	// This member is required.
	MemberConfiguration *types.MemberConfiguration

	// The unique identifier of the network in which the member is created.
	//
	// This member is required.
	NetworkId *string
}

type CreateMemberOutput

type CreateMemberOutput struct {

	// The unique identifier of the member.
	MemberId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateNetworkInput

type CreateNetworkInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time. This
	// identifier is required only if you make a service request directly using an HTTP
	// client. It is generated automatically if you use an AWS SDK or the AWS CLI.
	//
	// This member is required.
	ClientRequestToken *string

	// The blockchain framework that the network uses.
	//
	// This member is required.
	Framework types.Framework

	// The version of the blockchain framework that the network uses.
	//
	// This member is required.
	FrameworkVersion *string

	// Configuration properties for the first member within the network.
	//
	// This member is required.
	MemberConfiguration *types.MemberConfiguration

	// The name of the network.
	//
	// This member is required.
	Name *string

	// The voting rules used by the network to determine if a proposal is approved.
	//
	// This member is required.
	VotingPolicy *types.VotingPolicy

	// An optional description for the network.
	Description *string

	// Configuration properties of the blockchain framework relevant to the network
	// configuration.
	FrameworkConfiguration *types.NetworkFrameworkConfiguration
}

type CreateNetworkOutput

type CreateNetworkOutput struct {

	// The unique identifier for the first member within the network.
	MemberId *string

	// The unique identifier for the network.
	NetworkId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateNodeInput

type CreateNodeInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time. This
	// identifier is required only if you make a service request directly using an HTTP
	// client. It is generated automatically if you use an AWS SDK or the AWS CLI.
	//
	// This member is required.
	ClientRequestToken *string

	// The unique identifier of the member that owns this node.
	//
	// This member is required.
	MemberId *string

	// The unique identifier of the network in which this node runs.
	//
	// This member is required.
	NetworkId *string

	// The properties of a node configuration.
	//
	// This member is required.
	NodeConfiguration *types.NodeConfiguration
}

type CreateNodeOutput

type CreateNodeOutput struct {

	// The unique identifier of the node.
	NodeId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProposalInput

type CreateProposalInput struct {

	// The type of actions proposed, such as inviting a member or removing a member.
	// The types of Actions in a proposal are mutually exclusive. For example, a
	// proposal with Invitations actions cannot also contain Removals actions.
	//
	// This member is required.
	Actions *types.ProposalActions

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time. This
	// identifier is required only if you make a service request directly using an HTTP
	// client. It is generated automatically if you use an AWS SDK or the AWS CLI.
	//
	// This member is required.
	ClientRequestToken *string

	// The unique identifier of the member that is creating the proposal. This
	// identifier is especially useful for identifying the member making the proposal
	// when multiple members exist in a single AWS account.
	//
	// This member is required.
	MemberId *string

	// The unique identifier of the network for which the proposal is made.
	//
	// This member is required.
	NetworkId *string

	// A description for the proposal that is visible to voting members, for example,
	// "Proposal to add Example Corp. as member."
	Description *string
}

type CreateProposalOutput

type CreateProposalOutput struct {

	// The unique identifier of the proposal.
	ProposalId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteMemberInput

type DeleteMemberInput struct {

	// The unique identifier of the member to remove.
	//
	// This member is required.
	MemberId *string

	// The unique identifier of the network from which the member is removed.
	//
	// This member is required.
	NetworkId *string
}

type DeleteMemberOutput

type DeleteMemberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteNodeInput

type DeleteNodeInput struct {

	// The unique identifier of the member that owns this node.
	//
	// This member is required.
	MemberId *string

	// The unique identifier of the network that the node belongs to.
	//
	// This member is required.
	NetworkId *string

	// The unique identifier of the node.
	//
	// This member is required.
	NodeId *string
}

type DeleteNodeOutput

type DeleteNodeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetMemberInput

type GetMemberInput struct {

	// The unique identifier of the member.
	//
	// This member is required.
	MemberId *string

	// The unique identifier of the network to which the member belongs.
	//
	// This member is required.
	NetworkId *string
}

type GetMemberOutput

type GetMemberOutput struct {

	// The properties of a member.
	Member *types.Member

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetNetworkInput

type GetNetworkInput struct {

	// The unique identifier of the network to get information about.
	//
	// This member is required.
	NetworkId *string
}

type GetNetworkOutput

type GetNetworkOutput struct {

	// An object containing network configuration parameters.
	Network *types.Network

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetNodeInput

type GetNodeInput struct {

	// The unique identifier of the member that owns the node.
	//
	// This member is required.
	MemberId *string

	// The unique identifier of the network to which the node belongs.
	//
	// This member is required.
	NetworkId *string

	// The unique identifier of the node.
	//
	// This member is required.
	NodeId *string
}

type GetNodeOutput

type GetNodeOutput struct {

	// Properties of the node configuration.
	Node *types.Node

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetProposalInput

type GetProposalInput struct {

	// The unique identifier of the network for which the proposal is made.
	//
	// This member is required.
	NetworkId *string

	// The unique identifier of the proposal.
	//
	// This member is required.
	ProposalId *string
}

type GetProposalOutput

type GetProposalOutput struct {

	// Information about a proposal.
	Proposal *types.Proposal

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListInvitationsInput

type ListInvitationsInput struct {

	// The maximum number of invitations to return.
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string
}

type ListInvitationsOutput

type ListInvitationsOutput struct {

	// The invitations for the network.
	Invitations []*types.Invitation

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListMembersInput

type ListMembersInput struct {

	// The unique identifier of the network for which to list members.
	//
	// This member is required.
	NetworkId *string

	// An optional Boolean value. If provided, the request is limited either to members
	// that the current AWS account owns (true) or that other AWS accounts own (false).
	// If omitted, all members are listed.
	IsOwned *bool

	// The maximum number of members to return in the request.
	MaxResults *int32

	// The optional name of the member to list.
	Name *string

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// An optional status specifier. If provided, only members currently in this status
	// are listed.
	Status types.MemberStatus
}

type ListMembersOutput

type ListMembersOutput struct {

	// An array of MemberSummary objects. Each object contains details about a network
	// member.
	Members []*types.MemberSummary

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListNetworksInput

type ListNetworksInput struct {

	// An optional framework specifier. If provided, only networks of this framework
	// type are listed.
	Framework types.Framework

	// The maximum number of networks to list.
	MaxResults *int32

	// The name of the network.
	Name *string

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// An optional status specifier. If provided, only networks currently in this
	// status are listed.
	Status types.NetworkStatus
}

type ListNetworksOutput

type ListNetworksOutput struct {

	// An array of NetworkSummary objects that contain configuration properties for
	// each network.
	Networks []*types.NetworkSummary

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListNodesInput

type ListNodesInput struct {

	// The unique identifier of the member who owns the nodes to list.
	//
	// This member is required.
	MemberId *string

	// The unique identifier of the network for which to list nodes.
	//
	// This member is required.
	NetworkId *string

	// The maximum number of nodes to list.
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// An optional status specifier. If provided, only nodes currently in this status
	// are listed.
	Status types.NodeStatus
}

type ListNodesOutput

type ListNodesOutput struct {

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// An array of NodeSummary objects that contain configuration properties for each
	// node.
	Nodes []*types.NodeSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListProposalVotesInput

type ListProposalVotesInput struct {

	// The unique identifier of the network.
	//
	// This member is required.
	NetworkId *string

	// The unique identifier of the proposal.
	//
	// This member is required.
	ProposalId *string

	// The maximum number of votes to return.
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string
}

type ListProposalVotesOutput

type ListProposalVotesOutput struct {

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// The listing of votes.
	ProposalVotes []*types.VoteSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListProposalsInput

type ListProposalsInput struct {

	// The unique identifier of the network.
	//
	// This member is required.
	NetworkId *string

	// The maximum number of proposals to return.
	MaxResults *int32

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string
}

type ListProposalsOutput

type ListProposalsOutput struct {

	// The pagination token that indicates the next set of results to retrieve.
	NextToken *string

	// The summary of each proposal made on the network.
	Proposals []*types.ProposalSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type RejectInvitationInput

type RejectInvitationInput struct {

	// The unique identifier of the invitation to reject.
	//
	// This member is required.
	InvitationId *string
}

type RejectInvitationOutput

type RejectInvitationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type UpdateMemberInput

type UpdateMemberInput struct {

	// The unique ID of the member.
	//
	// This member is required.
	MemberId *string

	// The unique ID of the Managed Blockchain network to which the member belongs.
	//
	// This member is required.
	NetworkId *string

	// Configuration properties for publishing to Amazon CloudWatch Logs.
	LogPublishingConfiguration *types.MemberLogPublishingConfiguration
}

type UpdateMemberOutput

type UpdateMemberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateNodeInput

type UpdateNodeInput struct {

	// The unique ID of the member that owns the node.
	//
	// This member is required.
	MemberId *string

	// The unique ID of the Managed Blockchain network to which the node belongs.
	//
	// This member is required.
	NetworkId *string

	// The unique ID of the node.
	//
	// This member is required.
	NodeId *string

	// Configuration properties for publishing to Amazon CloudWatch Logs.
	LogPublishingConfiguration *types.NodeLogPublishingConfiguration
}

type UpdateNodeOutput

type UpdateNodeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type VoteOnProposalInput

type VoteOnProposalInput struct {

	// The unique identifier of the network.
	//
	// This member is required.
	NetworkId *string

	// The unique identifier of the proposal.
	//
	// This member is required.
	ProposalId *string

	// The value of the vote.
	//
	// This member is required.
	Vote types.VoteValue

	// The unique identifier of the member casting the vote.
	//
	// This member is required.
	VoterMemberId *string
}

type VoteOnProposalOutput

type VoteOnProposalOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_CreateMember.go api_op_CreateNetwork.go api_op_CreateNode.go api_op_CreateProposal.go api_op_DeleteMember.go api_op_DeleteNode.go api_op_GetMember.go api_op_GetNetwork.go api_op_GetNode.go api_op_GetProposal.go api_op_ListInvitations.go api_op_ListMembers.go api_op_ListNetworks.go api_op_ListNodes.go api_op_ListProposalVotes.go api_op_ListProposals.go api_op_RejectInvitation.go api_op_UpdateMember.go api_op_UpdateNode.go api_op_VoteOnProposal.go deserializers.go doc.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.27.0
Published
Oct 17, 2020
Platform
windows/amd64
Imports
28 packages
Last checked
1 second ago

Tools for package owners.