Skip to content

Proposal

Source code in docs_src/capo_managedblockchain/types/proposal.py
class Proposal(TypedDict, closed=True):
    proposal_id: NotRequired[
        "capo_managedblockchain.types.resource_id_string.ResourceIdString"
    ]
    """<p>The unique identifier of the proposal.</p>"""
    network_id: NotRequired[
        "capo_managedblockchain.types.resource_id_string.ResourceIdString"
    ]
    """<p>The unique identifier of the network for which the proposal is made.</p>"""
    description: NotRequired[
        "capo_managedblockchain.types.description_string.DescriptionString"
    ]
    """<p>The description of the proposal.</p>"""
    actions: NotRequired[
        "capo_managedblockchain.types.proposal_actions.ProposalActions"
    ]
    """<p>The actions to perform on the network if the proposal is <code>APPROVED</code>.</p>"""
    proposed_by_member_id: NotRequired[
        "capo_managedblockchain.types.resource_id_string.ResourceIdString"
    ]
    """<p>The unique identifier of the member that created the proposal.</p>"""
    proposed_by_member_name: NotRequired[
        "capo_managedblockchain.types.network_member_name_string.NetworkMemberNameString"
    ]
    """<p>The name of the member that created the proposal.</p>"""
    status: NotRequired["capo_managedblockchain.types.proposal_status.ProposalStatus"]
    """<p>The status of the proposal. Values are as follows:</p> <ul> <li> <p> <code>IN_PROGRESS</code> - The proposal is active and open for member voting.</p> </li> <li> <p> <code>APPROVED</code> - The proposal was approved with sufficient <code>YES</code> votes among members according to the <code>VotingPolicy</code> specified for the <code>Network</code>. The specified proposal actions are carried out.</p> </li> <li> <p> <code>REJECTED</code> - The proposal was rejected with insufficient <code>YES</code> votes among members according to the <code>VotingPolicy</code> specified for the <code>Network</code>. The specified <code>ProposalActions</code> aren't carried out.</p> </li> <li> <p> <code>EXPIRED</code> - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified <code>ProposalActions</code> aren't carried out.</p> </li> <li> <p> <code>ACTION_FAILED</code> - One or more of the specified <code>ProposalActions</code> in a proposal that was approved couldn't be completed because of an error. The <code>ACTION_FAILED</code> status occurs even if only one ProposalAction fails and other actions are successful.</p> </li> </ul>"""
    creation_date: NotRequired["capo_managedblockchain.types.timestamp.Timestamp"]
    """<p> The date and time that the proposal was created. </p>"""
    expiration_date: NotRequired["capo_managedblockchain.types.timestamp.Timestamp"]
    """<p> The date and time that the proposal expires. This is the <code>CreationDate</code> plus the <code>ProposalDurationInHours</code> that is specified in the <code>ProposalThresholdPolicy</code>. After this date and time, if members haven't cast enough votes to determine the outcome according to the voting policy, the proposal is <code>EXPIRED</code> and <code>Actions</code> aren't carried out. </p>"""
    yes_vote_count: NotRequired["capo_managedblockchain.types.vote_count.VoteCount"]
    """<p> The current total of <code>YES</code> votes cast on the proposal by members. </p>"""
    no_vote_count: NotRequired["capo_managedblockchain.types.vote_count.VoteCount"]
    """<p> The current total of <code>NO</code> votes cast on the proposal by members. </p>"""
    outstanding_vote_count: NotRequired[
        "capo_managedblockchain.types.vote_count.VoteCount"
    ]
    """<p> The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of <code>YES</code> votes and <code>NO</code> votes. </p>"""
    tags: NotRequired["capo_managedblockchain.types.output_tag_map.OutputTagMap"]
    """<p>Tags assigned to the proposal. Each tag consists of a key and optional value.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"""
    arn: NotRequired["capo_managedblockchain.types.arn_string.ArnString"]
    """<p>The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"""

actions instance-attribute

actions: NotRequired[ProposalActions]

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

arn instance-attribute

arn: NotRequired[ArnString]

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

creation_date instance-attribute

creation_date: NotRequired[Timestamp]

The date and time that the proposal was created.

description instance-attribute

description: NotRequired[DescriptionString]

The description of the proposal.

expiration_date instance-attribute

expiration_date: NotRequired[Timestamp]

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 haven't cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions aren't carried out.

network_id instance-attribute

network_id: NotRequired[ResourceIdString]

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

no_vote_count instance-attribute

no_vote_count: NotRequired[VoteCount]

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

outstanding_vote_count instance-attribute

outstanding_vote_count: NotRequired[VoteCount]

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.

proposal_id instance-attribute

proposal_id: NotRequired[ResourceIdString]

The unique identifier of the proposal.

proposed_by_member_id instance-attribute

proposed_by_member_id: NotRequired[ResourceIdString]

The unique identifier of the member that created the proposal.

proposed_by_member_name instance-attribute

proposed_by_member_name: NotRequired[NetworkMemberNameString]

The name of the member that created the proposal.

status instance-attribute

status: NotRequired[ProposalStatus]

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 aren't carried out.

  • EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.

  • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.

tags instance-attribute

tags: NotRequired[OutputTagMap]

Tags assigned to the proposal. Each tag consists of a key and optional value.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

yes_vote_count instance-attribute

yes_vote_count: NotRequired[VoteCount]

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