File Coverage

blib/lib/Paws/Organizations/Handshake.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::Handshake;
2 1     1   480 use Moose;
  1         3  
  1         9  
3             has Action => (is => 'ro', isa => 'Str');
4             has Arn => (is => 'ro', isa => 'Str');
5             has ExpirationTimestamp => (is => 'ro', isa => 'Str');
6             has Id => (is => 'ro', isa => 'Str');
7             has Parties => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::HandshakeParty]');
8             has RequestedTimestamp => (is => 'ro', isa => 'Str');
9             has Resources => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::HandshakeResource]');
10             has State => (is => 'ro', isa => 'Str');
11             1;
12              
13             ### main pod documentation begin ###
14              
15             =head1 NAME
16              
17             Paws::Organizations::Handshake
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::Organizations::Handshake object:
29              
30             $service_obj->Method(Att1 => { Action => $value, ..., State => $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::Organizations::Handshake object:
35              
36             $result = $service_obj->Method(...);
37             $result->Att1->Action
38              
39             =head1 DESCRIPTION
40              
41             Contains information that must be exchanged to securely establish a
42             relationship between two accounts (an I<originator> and a
43             I<recipient>). For example, when a master account (the originator)
44             invites another account (the recipient) to join its organization, the
45             two accounts exchange information as a series of handshake requests and
46             responses.
47              
48             B<Note:> Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in
49             lists for only 30 days after entering that state After that they are
50             deleted.
51              
52             =head1 ATTRIBUTES
53              
54              
55             =head2 Action => Str
56              
57             The type of handshake, indicating what action occurs when the recipient
58             accepts the handshake.
59              
60              
61             =head2 Arn => Str
62              
63             The Amazon Resource Name (ARN) of a handshake.
64              
65             For more information about ARNs in Organizations, see ARN Formats
66             Supported by Organizations in the I<AWS Organizations User Guide>.
67              
68              
69             =head2 ExpirationTimestamp => Str
70              
71             The date and time that the handshake expires. If the recipient of the
72             handshake request fails to respond before the specified date and time,
73             the handshake becomes inactive and is no longer valid.
74              
75              
76             =head2 Id => Str
77              
78             The unique identifier (ID) of a handshake. The originating account
79             creates the ID when it initiates the handshake.
80              
81             The regex pattern for handshake ID string requires "h-" followed by
82             from 8 to 32 lower-case letters or digits.
83              
84              
85             =head2 Parties => ArrayRef[L<Paws::Organizations::HandshakeParty>]
86              
87             Information about the two accounts that are participating in the
88             handshake.
89              
90              
91             =head2 RequestedTimestamp => Str
92              
93             The date and time that the handshake request was made.
94              
95              
96             =head2 Resources => ArrayRef[L<Paws::Organizations::HandshakeResource>]
97              
98             Additional information that is needed to process the handshake.
99              
100              
101             =head2 State => Str
102              
103             The current state of the handshake. Use the state to trace the flow of
104             the handshake through the process from its creation to its acceptance.
105             The meaning of each of the valid values is as follows:
106              
107             =over
108              
109             =item *
110              
111             B<REQUESTED>: This handshake was sent to multiple recipients
112             (applicable to only some handshake types) and not all recipients have
113             responded yet. The request stays in this state until all recipients
114             respond.
115              
116             =item *
117              
118             B<OPEN>: This handshake was sent to multiple recipients (applicable to
119             only some policy types) and all recipients have responded, allowing the
120             originator to complete the handshake action.
121              
122             =item *
123              
124             B<CANCELED>: This handshake is no longer active because it was canceled
125             by the originating account.
126              
127             =item *
128              
129             B<ACCEPTED>: This handshake is complete because it has been accepted by
130             the recipient.
131              
132             =item *
133              
134             B<DECLINED>: This handshake is no longer active because it was declined
135             by the recipient account.
136              
137             =item *
138              
139             B<EXPIRED>: This handshake is no longer active because the originator
140             did not receive a response of any kind from the recipient before the
141             expiration time (15 days).
142              
143             =back
144              
145              
146              
147              
148             =head1 SEE ALSO
149              
150             This class forms part of L<Paws>, describing an object used in L<Paws::Organizations>
151              
152             =head1 BUGS and CONTRIBUTIONS
153              
154             The source code is located here: https://github.com/pplu/aws-sdk-perl
155              
156             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
157              
158             =cut
159