[ aws . managedblockchain ]

get-proposal

Description

Returns detailed information about a proposal.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-proposal
--network-id <value>
--proposal-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--network-id (string)

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

--proposal-id (string)

The unique identifier of the proposal.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Proposal -> (structure)

Information about a proposal.

ProposalId -> (string)

The unique identifier of the proposal.

NetworkId -> (string)

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

Description -> (string)

The description of the proposal.

Actions -> (structure)

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

Invitations -> (list)

The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network.

(structure)

An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED .

Applies only to Hyperledger Fabric.

Principal -> (string)

The AWS account ID to invite.

Removals -> (list)

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.

(structure)

An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED . The member and all associated resources are deleted from the network.

Applies only to Hyperledger Fabric.

MemberId -> (string)

The unique identifier of the member to remove.

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 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.

CreationDate -> (timestamp)

The date and time that the proposal was created.

ExpirationDate -> (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 have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.

YesVoteCount -> (integer)

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

NoVoteCount -> (integer)

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

OutstandingVoteCount -> (integer)

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.

Tags -> (map)

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 .

key -> (string)

value -> (string)

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 AWS General Reference .