Amazonka.ManagedBlockChain.CreateProposal

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.

Applies only to Hyperledger Fabric.

Creating a Request

data CreateProposal

See: newCreateProposal smart constructor.

Constructors

CreateProposal'

Fields

• description :: Maybe Text

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

• tags :: Maybe (HashMap Text Text)

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

  When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.

  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.

• clientRequestToken :: Text

  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 Amazon Web Services SDK or the CLI.

• networkId :: Text

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

• memberId :: Text

  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 Amazon Web Services account.

• actions :: ProposalActions

  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.

Instances

ToJSON CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

toJSON :: CreateProposal -> Value

toEncoding :: CreateProposal -> Encoding

toJSONList :: [CreateProposal] -> Value

toEncodingList :: [CreateProposal] -> Encoding

ToHeaders CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

toHeaders :: CreateProposal -> [Header]

ToPath CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

toPath :: CreateProposal -> ByteString

ToQuery CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

toQuery :: CreateProposal -> QueryString

AWSRequest CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Associated Types

type AWSResponse CreateProposal

Methods

request :: (Service -> Service) -> CreateProposal -> Request CreateProposal

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateProposal -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProposal)))

Generic CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Associated Types

type Rep CreateProposal :: Type -> Type

Methods

from :: CreateProposal -> Rep CreateProposal x

to :: Rep CreateProposal x -> CreateProposal

Read CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

readsPrec :: Int -> ReadS CreateProposal

readList :: ReadS [CreateProposal]

readPrec :: ReadPrec CreateProposal

readListPrec :: ReadPrec [CreateProposal]

Show CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

showsPrec :: Int -> CreateProposal -> ShowS

show :: CreateProposal -> String

showList :: [CreateProposal] -> ShowS

NFData CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

rnf :: CreateProposal -> ()

Eq CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

(==) :: CreateProposal -> CreateProposal -> Bool

(/=) :: CreateProposal -> CreateProposal -> Bool

Hashable CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

hashWithSalt :: Int -> CreateProposal -> Int

hash :: CreateProposal -> Int

type AWSResponse CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

type AWSResponse CreateProposal = CreateProposalResponse

type Rep CreateProposal

Defined in Amazonka.ManagedBlockChain.CreateProposal

type Rep CreateProposal = D1 ('MetaData "CreateProposal" "Amazonka.ManagedBlockChain.CreateProposal" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "CreateProposal'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "networkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "memberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProposalActions)))))

newCreateProposal

Arguments

:: Text

$sel:clientRequestToken:CreateProposal'

-> Text

CreateProposal

-> Text

CreateProposal

-> ProposalActions

CreateProposal

-> CreateProposal

Create a value of CreateProposal with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateProposal, createProposal_description - A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."

CreateProposal, createProposal_tags - Tags to assign to the proposal. Each tag consists of a key and optional value.

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.

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.

$sel:clientRequestToken:CreateProposal', createProposal_clientRequestToken - 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 Amazon Web Services SDK or the CLI.

CreateProposal, createProposal_networkId - The unique identifier of the network for which the proposal is made.

CreateProposal, createProposal_memberId - 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 Amazon Web Services account.

CreateProposal, createProposal_actions - 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.

Request Lenses

createProposal_description :: Lens' CreateProposal (Maybe Text)

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

createProposal_tags :: Lens' CreateProposal (Maybe (HashMap Text Text))

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

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.

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.

createProposal_clientRequestToken :: Lens' CreateProposal Text

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 Amazon Web Services SDK or the CLI.

createProposal_networkId :: Lens' CreateProposal Text

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

createProposal_memberId :: Lens' CreateProposal Text

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 Amazon Web Services account.

createProposal_actions :: Lens' CreateProposal ProposalActions

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.

Destructuring the Response

data CreateProposalResponse

See: newCreateProposalResponse smart constructor.

Constructors

CreateProposalResponse'

Fields

• proposalId :: Maybe Text

  The unique identifier of the proposal.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateProposalResponse

Defined in Amazonka.ManagedBlockChain.CreateProposal

Associated Types

type Rep CreateProposalResponse :: Type -> Type

Methods

from :: CreateProposalResponse -> Rep CreateProposalResponse x

to :: Rep CreateProposalResponse x -> CreateProposalResponse

Read CreateProposalResponse

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

readsPrec :: Int -> ReadS CreateProposalResponse

readList :: ReadS [CreateProposalResponse]

readPrec :: ReadPrec CreateProposalResponse

readListPrec :: ReadPrec [CreateProposalResponse]

Show CreateProposalResponse

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

showsPrec :: Int -> CreateProposalResponse -> ShowS

show :: CreateProposalResponse -> String

showList :: [CreateProposalResponse] -> ShowS

NFData CreateProposalResponse

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

rnf :: CreateProposalResponse -> ()

Eq CreateProposalResponse

Defined in Amazonka.ManagedBlockChain.CreateProposal

Methods

(==) :: CreateProposalResponse -> CreateProposalResponse -> Bool

(/=) :: CreateProposalResponse -> CreateProposalResponse -> Bool

type Rep CreateProposalResponse

Defined in Amazonka.ManagedBlockChain.CreateProposal

type Rep CreateProposalResponse = D1 ('MetaData "CreateProposalResponse" "Amazonka.ManagedBlockChain.CreateProposal" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "CreateProposalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "proposalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateProposalResponse

Arguments

:: Int

$sel:httpStatus:CreateProposalResponse'

-> CreateProposalResponse

Create a value of CreateProposalResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateProposalResponse, createProposalResponse_proposalId - The unique identifier of the proposal.

$sel:httpStatus:CreateProposalResponse', createProposalResponse_httpStatus - The response's http status code.

Response Lenses

createProposalResponse_proposalId :: Lens' CreateProposalResponse (Maybe Text)

The unique identifier of the proposal.

createProposalResponse_httpStatus :: Lens' CreateProposalResponse Int

The response's http status code.