[ aws . managedblockchain ]

create-proposal

Description

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-proposal
[--client-request-token <value>]
--network-id <value>
--member-id <value>
--actions <value>
[--description <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--client-request-token (string)

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.

--network-id (string)

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

--member-id (string)

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.

--actions (structure)

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.

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 .

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.

MemberId -> (string)

The unique identifier of the member to remove.

Shorthand Syntax:

Invitations=[{Principal=string},{Principal=string}],Removals=[{MemberId=string},{MemberId=string}]

JSON Syntax:

{
  "Invitations": [
    {
      "Principal": "string"
    }
    ...
  ],
  "Removals": [
    {
      "MemberId": "string"
    }
    ...
  ]
}

--description (string)

A description for the proposal that is visible to voting members, for example, “Proposal to add Example Corp. as member.”

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ProposalId -> (string)

The unique identifier of the proposal.