« blib/lib/Paws/ManagedBlockchain/InputTagMap.pm
↑ Summary
blib/lib/Paws/ManagedBlockchain/InviteAction.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ManagedBlockchain::Invitation; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreationDate => (is => 'ro', isa => 'Str'); | ||
| 6 | has ExpirationDate => (is => 'ro', isa => 'Str'); | ||
| 7 | has InvitationId => (is => 'ro', isa => 'Str'); | ||
| 8 | has NetworkSummary => (is => 'ro', isa => 'Paws::ManagedBlockchain::NetworkSummary'); | ||
| 9 | has Status => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::ManagedBlockchain::Invitation | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::ManagedBlockchain::Invitation object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Arn => $value, ..., Status => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::ManagedBlockchain::Invitation object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Arn | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | An invitation to an AWS account to create a member and join the | ||
| 42 | network. | ||
| 43 | |||
| 44 | Applies only to Hyperledger Fabric. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Arn => Str | ||
| 50 | |||
| 51 | The Amazon Resource Name (ARN) of the invitation. For more information | ||
| 52 | about ARNs and their format, see Amazon Resource Names (ARNs) | ||
| 53 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 54 | in the I<AWS General Reference>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CreationDate => Str | ||
| 58 | |||
| 59 | The date and time that the invitation was created. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ExpirationDate => Str | ||
| 63 | |||
| 64 | The date and time that the invitation expires. This is the | ||
| 65 | C<CreationDate> plus the C<ProposalDurationInHours> that is specified | ||
| 66 | in the C<ProposalThresholdPolicy>. After this date and time, the | ||
| 67 | invitee can no longer create a member and join the network using this | ||
| 68 | C<InvitationId>. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 InvitationId => Str | ||
| 72 | |||
| 73 | The unique identifier for the invitation. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 NetworkSummary => L<Paws::ManagedBlockchain::NetworkSummary> | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 Status => Str | ||
| 82 | |||
| 83 | The status of the invitation: | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<PENDING> - The invitee has not created a member to join the network, | ||
| 90 | and the invitation has not yet expired. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<ACCEPTING> - The invitee has begun creating a member, and creation | ||
| 95 | has not yet completed. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<ACCEPTED> - The invitee created a member and joined the network using | ||
| 100 | the C<InvitationID>. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<REJECTED> - The invitee rejected the invitation. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<EXPIRED> - The invitee neither created a member nor rejected the | ||
| 109 | invitation before the C<ExpirationDate>. | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, describing an object used in L<Paws::ManagedBlockchain> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |