« blib/lib/Paws/Organizations/HandshakeParty.pm
↑ Summary
blib/lib/Paws/Organizations/InviteAccountToOrganization.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Organizations::HandshakeResource; | ||
| 3 | use Moose; | ||
| 4 | has Resources => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::HandshakeResource]'); | ||
| 5 | has Type => (is => 'ro', isa => 'Str'); | ||
| 6 | has Value => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Organizations::HandshakeResource | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Organizations::HandshakeResource object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Resources => $value, ..., Value => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Organizations::HandshakeResource object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Resources | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Contains additional data that is needed to process a handshake. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Resources => ArrayRef[L<Paws::Organizations::HandshakeResource>] | ||
| 44 | |||
| 45 | When needed, contains an additional array of C<HandshakeResource> | ||
| 46 | objects. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Type => Str | ||
| 50 | |||
| 51 | The type of information being passed, specifying how the value is to be | ||
| 52 | interpreted by the other party: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<ACCOUNT> - Specifies an AWS account ID number. | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | C<ORGANIZATION> - Specifies an organization ID number. | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<EMAIL> - Specifies the email address that is associated with the | ||
| 67 | account that receives the handshake. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<OWNER_EMAIL> - Specifies the email address associated with the | ||
| 72 | management account. Included as information about an organization. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<OWNER_NAME> - Specifies the name associated with the management | ||
| 77 | account. Included as information about an organization. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<NOTES> - Additional text provided by the handshake initiator and | ||
| 82 | intended for the recipient to read. | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Value => Str | ||
| 89 | |||
| 90 | The information that is passed to the other party in the handshake. The | ||
| 91 | format of the value string must match the requirements of the specified | ||
| 92 | type. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, describing an object used in L<Paws::Organizations> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |