ManagedBlockchain / Client / list_proposals

list_proposals#

ManagedBlockchain.Client.list_proposals(**kwargs)#

Returns a list of proposals for the network.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.list_proposals(
    NetworkId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • NetworkId (string) –

    [REQUIRED]

    The unique identifier of the network.

  • MaxResults (integer) – The maximum number of proposals to return.

  • NextToken (string) – The pagination token that indicates the next set of results to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Proposals': [
        {
            'ProposalId': 'string',
            'Description': 'string',
            'ProposedByMemberId': 'string',
            'ProposedByMemberName': 'string',
            'Status': 'IN_PROGRESS'|'APPROVED'|'REJECTED'|'EXPIRED'|'ACTION_FAILED',
            'CreationDate': datetime(2015, 1, 1),
            'ExpirationDate': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Proposals (list) –

      The summary of each proposal made on the network.

      • (dict) –

        Properties of a proposal.

        Applies only to Hyperledger Fabric.

        • ProposalId (string) –

          The unique identifier of the proposal.

        • Description (string) –

          The description of the proposal.

        • ProposedByMemberId (string) –

          The unique identifier of the member that created the proposal.

        • ProposedByMemberName (string) –

          The name of the member that created the proposal.

        • Status (string) –

          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.

        • CreationDate (datetime) –

          The date and time that the proposal was created.

        • ExpirationDate (datetime) –

          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.

        • Arn (string) –

          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 .

    • NextToken (string) –

      The pagination token that indicates the next set of results to retrieve.

Exceptions

  • ManagedBlockchain.Client.exceptions.InvalidRequestException

  • ManagedBlockchain.Client.exceptions.ResourceNotFoundException

  • ManagedBlockchain.Client.exceptions.AccessDeniedException

  • ManagedBlockchain.Client.exceptions.ThrottlingException

  • ManagedBlockchain.Client.exceptions.InternalServiceErrorException