Integer thresholdPercentage
The percentage of votes among all members that must be YES for a proposal to be approved. For
example, a ThresholdPercentage value of 50 indicates 50%. The
ThresholdComparator determines the precise comparison. If a ThresholdPercentage value
of 50 is specified on a network with 10 members, along with a ThresholdComparator value
of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be
approved.
Integer proposalDurationInHours
The duration from the time that a proposal is created until it expires. If members cast neither the required
number of YES votes to approve the proposal nor the number of NO votes required to
reject it before the duration expires, the proposal is EXPIRED and ProposalActions are
not carried out.
String thresholdComparator
Determines whether the vote percentage must be greater than the ThresholdPercentage or must be
greater than or equal to the ThreholdPercentage to be approved.
String clientRequestToken
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.
String invitationId
The unique identifier of the invitation that is sent to the member to join the network.
String networkId
The unique identifier of the network in which the member is created.
MemberConfiguration memberConfiguration
Member configuration parameters.
String memberId
The unique identifier of the member.
String clientRequestToken
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.
String name
The name of the network.
String description
An optional description for the network.
String framework
The blockchain framework that the network uses.
String frameworkVersion
The version of the blockchain framework that the network uses.
NetworkFrameworkConfiguration frameworkConfiguration
Configuration properties of the blockchain framework relevant to the network configuration.
VotingPolicy votingPolicy
The voting rules used by the network to determine if a proposal is approved.
MemberConfiguration memberConfiguration
Configuration properties for the first member within the network.
String clientRequestToken
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.
String networkId
The unique identifier of the network in which this node runs.
String memberId
The unique identifier of the member that owns this node.
NodeConfiguration nodeConfiguration
The properties of a node configuration.
String nodeId
The unique identifier of the node.
String clientRequestToken
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.
String networkId
The unique identifier of the network for which the proposal is made.
String memberId
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.
ProposalActions actions
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.
String description
A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."
String proposalId
The unique identifier of the proposal.
Member member
The properties of a member.
String networkId
The unique identifier of the network to get information about.
Network network
An object containing network configuration parameters.
Node node
Properties of the node configuration.
Proposal proposal
Information about a proposal.
String invitationId
The unique identifier for the invitation.
Date creationDate
The date and time that the invitation was created.
Date expirationDate
The date and time that the invitation expires. This is the CreationDate plus the
ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this
date and time, the invitee can no longer create a member and join the network using this
InvitationId.
String status
The status of the invitation:
PENDING - The invitee has not created a member to join the network, and the invitation has not yet
expired.
ACCEPTING - The invitee has begun creating a member, and creation has not yet completed.
ACCEPTED - The invitee created a member and joined the network using the InvitationID.
REJECTED - The invitee rejected the invitation.
EXPIRED - The invitee neither created a member nor rejected the invitation before the
ExpirationDate.
NetworkSummary networkSummary
String principal
The AWS account ID to invite.
String networkId
The unique identifier of the network for which to list members.
String name
The optional name of the member to list.
String status
An optional status specifier. If provided, only members currently in this status are listed.
Boolean isOwned
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.
Integer maxResults
The maximum number of members to return in the request.
String nextToken
The pagination token that indicates the next set of results to retrieve.
String name
The name of the network.
String framework
An optional framework specifier. If provided, only networks of this framework type are listed.
String status
An optional status specifier. If provided, only networks currently in this status are listed.
Integer maxResults
The maximum number of networks to list.
String nextToken
The pagination token that indicates the next set of results to retrieve.
String networkId
The unique identifier of the network for which to list nodes.
String memberId
The unique identifier of the member who owns the nodes to list.
String status
An optional status specifier. If provided, only nodes currently in this status are listed.
Integer maxResults
The maximum number of nodes to list.
String nextToken
The pagination token that indicates the next set of results to retrieve.
String networkId
The unique identifier of the network.
String proposalId
The unique identifier of the proposal.
Integer maxResults
The maximum number of votes to return.
String nextToken
The pagination token that indicates the next set of results to retrieve.
String networkId
The unique identifier of the network to which the member belongs.
String id
The unique identifier of the member.
String name
The name of the member.
String description
An optional description for the member.
MemberFrameworkAttributes frameworkAttributes
Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.
String status
The status of a member.
CREATING - The AWS account is in the process of creating a member.
AVAILABLE - The member has been created and can participate in the network.
CREATE_FAILED - The AWS account attempted to create a member and creation failed.
DELETING - The member and all associated resources are in the process of being deleted. Either the
AWS account that owns the member deleted it, or the member is being deleted as the result of an
APPROVED PROPOSAL to remove the member.
DELETED - The member can no longer participate on the network and all associated resources are
deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of
an APPROVED PROPOSAL to remove the member.
Date creationDate
The date and time that the member was created.
String name
The name of the member.
String description
An optional description of the member.
MemberFrameworkConfiguration frameworkConfiguration
Configuration properties of the blockchain framework relevant to the member.
String adminUsername
The user name for the member's initial administrative user.
String adminPassword
The password for the member's initial administrative user. The AdminPassword must be at least eight
characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase
letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(\), @,
or a space.
MemberFabricAttributes fabric
Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric.
MemberFabricConfiguration fabric
Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.
String id
The unique identifier of the member.
String name
The name of the member.
String description
An optional description of the member.
String status
The status of the member.
CREATING - The AWS account is in the process of creating a member.
AVAILABLE - The member has been created and can participate in the network.
CREATE_FAILED - The AWS account attempted to create a member and creation failed.
DELETING - The member and all associated resources are in the process of being deleted. Either the
AWS account that owns the member deleted it, or the member is being deleted as the result of an
APPROVED PROPOSAL to remove the member.
DELETED - The member can no longer participate on the network and all associated resources are
deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of
an APPROVED PROPOSAL to remove the member.
Date creationDate
The date and time that the member was created.
Boolean isOwned
An indicator of whether the member is owned by your AWS account or a different AWS account.
String id
The unique identifier of the network.
String name
The name of the network.
String description
Attributes of the blockchain framework for the network.
String framework
The blockchain framework that the network uses.
String frameworkVersion
The version of the blockchain framework that the network uses.
NetworkFrameworkAttributes frameworkAttributes
Attributes of the blockchain framework that the network uses.
String vpcEndpointServiceName
The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources.
VotingPolicy votingPolicy
The voting rules for the network to decide if a proposal is accepted.
String status
The current status of the network.
Date creationDate
The date and time that the network was created.
String orderingServiceEndpoint
The endpoint of the ordering service for the network.
String edition
The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing.
String edition
The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.
NetworkFabricAttributes fabric
Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.
NetworkFabricConfiguration fabric
Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric.
String id
The unique identifier of the network.
String name
The name of the network.
String description
An optional description of the network.
String framework
The blockchain framework that the network uses.
String frameworkVersion
The version of the blockchain framework that the network uses.
String status
The current status of the network.
Date creationDate
The date and time that the network was created.
String networkId
The unique identifier of the network that the node is in.
String memberId
The unique identifier of the member to which the node belongs.
String id
The unique identifier of the node.
String instanceType
The instance type of the node.
String availabilityZone
The Availability Zone in which the node exists.
NodeFrameworkAttributes frameworkAttributes
Attributes of the blockchain framework being used.
String status
The status of the node.
Date creationDate
The date and time that the node was created.
NodeFabricAttributes fabric
Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.
String id
The unique identifier of the node.
String status
The status of the node.
Date creationDate
The date and time that the node was created.
String availabilityZone
The Availability Zone in which the node exists.
String instanceType
The EC2 instance type for the node.
String proposalId
The unique identifier of the proposal.
String networkId
The unique identifier of the network for which the proposal is made.
String description
The description of the proposal.
ProposalActions actions
The actions to perform on the network if the proposal is APPROVED.
String proposedByMemberId
The unique identifier of the member that created the proposal.
String proposedByMemberName
The name of the member that created the proposal.
String status
The status of the proposal. Values are as follows:
IN_PROGRESS - The proposal is active and open for member voting.
APPROVED - The proposal was approved with sufficient YES votes among members according
to the VotingPolicy specified for the Network. The specified proposal actions are
carried out.
REJECTED - The proposal was rejected with insufficient YES votes among members
according to the VotingPolicy specified for the Network. The specified
ProposalActions are not carried out.
EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before
the proposal expired. The specified ProposalActions are not carried out.
ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was
approved could not be completed because of an error.
Date creationDate
The date and time that the proposal was created.
Date expirationDate
The date and time that the proposal expires. This is the CreationDate plus the
ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this
date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the
proposal is EXPIRED and Actions are not carried out.
Integer yesVoteCount
The current total of YES votes cast on the proposal by members.
Integer noVoteCount
The current total of NO votes cast on the proposal by members.
Integer outstandingVoteCount
The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus
the sum of YES votes and NO votes.
List<E> invitations
The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join
the network.
List<E> removals
The actions to perform for an APPROVED proposal to remove a member from the network, which deletes
the member and all associated member resources from the network.
String proposalId
The unique identifier of the proposal.
String description
The description of the proposal.
String proposedByMemberId
The unique identifier of the member that created the proposal.
String proposedByMemberName
The name of the member that created the proposal.
String status
The status of the proposal. Values are as follows:
IN_PROGRESS - The proposal is active and open for member voting.
APPROVED - The proposal was approved with sufficient YES votes among members according
to the VotingPolicy specified for the Network. The specified proposal actions are
carried out.
REJECTED - The proposal was rejected with insufficient YES votes among members
according to the VotingPolicy specified for the Network. The specified
ProposalActions are not carried out.
EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before
the proposal expired. The specified ProposalActions are not carried out.
ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was
approved could not be completed because of an error.
Date creationDate
The date and time that the proposal was created.
Date expirationDate
The date and time that the proposal expires. This is the CreationDate plus the
ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this
date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the
proposal is EXPIRED and Actions are not carried out.
String invitationId
The unique identifier of the invitation to reject.
String memberId
The unique identifier of the member to remove.
ApprovalThresholdPolicy approvalThresholdPolicy
Defines the rules for the network for voting on proposals, such as the percentage of YES votes
required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals
and is specified when the network is created.
Copyright © 2019. All rights reserved.