« blib/lib/Paws/ManagedBlockchain/CreateNodeOutput.pm
↑ Summary
blib/lib/Paws/ManagedBlockchain/CreateProposalOutput.pm »
| 1 | |||
| 2 | package Paws::ManagedBlockchain::CreateProposal; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'Paws::ManagedBlockchain::ProposalActions', required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has MemberId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has NetworkId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'networkId', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'Paws::ManagedBlockchain::InputTagMap'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateProposal'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/networks/{networkId}/proposals'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ManagedBlockchain::CreateProposalOutput'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ManagedBlockchain::CreateProposal - Arguments for method CreateProposal on L<Paws::ManagedBlockchain> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateProposal on the | ||
| 28 | L<Amazon Managed Blockchain|Paws::ManagedBlockchain> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateProposal. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateProposal. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $managedblockchain = Paws->service('ManagedBlockchain'); | ||
| 36 | my $CreateProposalOutput = $managedblockchain->CreateProposal( | ||
| 37 | Actions => { | ||
| 38 | Invitations => [ | ||
| 39 | { | ||
| 40 | Principal => 'MyPrincipalString', | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | Removals => [ | ||
| 46 | { | ||
| 47 | MemberId => 'MyResourceIdString', # min: 1, max: 32 | ||
| 48 | |||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | }, | ||
| 53 | ClientRequestToken => 'MyClientRequestTokenString', | ||
| 54 | MemberId => 'MyResourceIdString', | ||
| 55 | NetworkId => 'MyResourceIdString', | ||
| 56 | Description => 'MyDescriptionString', # OPTIONAL | ||
| 57 | Tags => { | ||
| 58 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 59 | }, # OPTIONAL | ||
| 60 | ); | ||
| 61 | |||
| 62 | # Results: | ||
| 63 | my $ProposalId = $CreateProposalOutput->ProposalId; | ||
| 64 | |||
| 65 | # Returns a L<Paws::ManagedBlockchain::CreateProposalOutput> object. | ||
| 66 | |||
| 67 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 68 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/managedblockchain/CreateProposal> | ||
| 69 | |||
| 70 | =head1 ATTRIBUTES | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> Actions => L<Paws::ManagedBlockchain::ProposalActions> | ||
| 74 | |||
| 75 | The type of actions proposed, such as inviting a member or removing a | ||
| 76 | member. The types of C<Actions> in a proposal are mutually exclusive. | ||
| 77 | For example, a proposal with C<Invitations> actions cannot also contain | ||
| 78 | C<Removals> actions. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 83 | |||
| 84 | A unique, case-sensitive identifier that you provide to ensure the | ||
| 85 | idempotency of the operation. An idempotent operation completes no more | ||
| 86 | than one time. This identifier is required only if you make a service | ||
| 87 | request directly using an HTTP client. It is generated automatically if | ||
| 88 | you use an AWS SDK or the AWS CLI. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Description => Str | ||
| 93 | |||
| 94 | A description for the proposal that is visible to voting members, for | ||
| 95 | example, "Proposal to add Example Corp. as member." | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> MemberId => Str | ||
| 100 | |||
| 101 | The unique identifier of the member that is creating the proposal. This | ||
| 102 | identifier is especially useful for identifying the member making the | ||
| 103 | proposal when multiple members exist in a single AWS account. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> NetworkId => Str | ||
| 108 | |||
| 109 | The unique identifier of the network for which the proposal is made. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 Tags => L<Paws::ManagedBlockchain::InputTagMap> | ||
| 114 | |||
| 115 | Tags to assign to the proposal. Each tag consists of a key and optional | ||
| 116 | value. | ||
| 117 | |||
| 118 | When specifying tags during creation, you can specify multiple | ||
| 119 | key-value pairs in a single request, with an overall maximum of 50 tags | ||
| 120 | added to each resource. If the proposal is for a network invitation, | ||
| 121 | the invitation inherits the tags added to the proposal. | ||
| 122 | |||
| 123 | For more information about tags, see Tagging Resources | ||
| 124 | (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) | ||
| 125 | in the I<Amazon Managed Blockchain Ethereum Developer Guide>, or | ||
| 126 | Tagging Resources | ||
| 127 | (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) | ||
| 128 | in the I<Amazon Managed Blockchain Hyperledger Fabric Developer Guide>. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method CreateProposal in L<Paws::ManagedBlockchain> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |