File Coverage

blib/lib/Paws/Organizations/HandshakeResource.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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