Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--generate-cli-skeleton <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.

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

ProposalId -> (string)

The unique identifier of the proposal.