Amazon Managed Blockchain
API Reference (API Version 2018-09-24)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Proposal

Properties of a proposal on a Managed Blockchain network.

Contents

Actions

The actions to perform on the network if the proposal is APPROVED.

Type: ProposalActions object

Required: No

CreationDate

The date and time that the proposal was created.

Type: Timestamp

Required: No

Description

The description of the proposal.

Type: String

Length Constraints: Maximum length of 128.

Required: No

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.

Type: Timestamp

Required: No

NetworkId

The unique identifier of the network for which the proposal is made.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

NoVoteCount

The current total of NO votes cast on the proposal by members.

Type: Integer

Required: No

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.

Type: Integer

Required: No

ProposalId

The unique identifier of the proposal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

ProposedByMemberId

The unique identifier of the member that created the proposal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: No

ProposedByMemberName

The name of the member that created the proposal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^(?!-)^[^0-9](?!.*--)[A-Za-z0-9-]+[^- ]$

Required: No

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. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.

Type: String

Valid Values: IN_PROGRESS | APPROVED | REJECTED | EXPIRED | ACTION_FAILED

Required: No

YesVoteCount

The current total of YES votes cast on the proposal by members.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: