« blib/lib/Paws/Organizations/EnabledServicePrincipal.pm
↑ Summary
blib/lib/Paws/Organizations/HandshakeFilter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Organizations::Handshake; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 6 | has ExpirationTimestamp => (is => 'ro', isa => 'Str'); | ||
| 7 | has Id => (is => 'ro', isa => 'Str'); | ||
| 8 | has Parties => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::HandshakeParty]'); | ||
| 9 | has RequestedTimestamp => (is => 'ro', isa => 'Str'); | ||
| 10 | has Resources => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::HandshakeResource]'); | ||
| 11 | has State => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Organizations::Handshake | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::Organizations::Handshake object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { Action => $value, ..., State => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::Organizations::Handshake object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->Action | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Contains information that must be exchanged to securely establish a | ||
| 44 | relationship between two accounts (an I<originator> and a | ||
| 45 | I<recipient>). For example, when a management account (the originator) | ||
| 46 | invites another account (the recipient) to join its organization, the | ||
| 47 | two accounts exchange information as a series of handshake requests and | ||
| 48 | responses. | ||
| 49 | |||
| 50 | B<Note:> Handshakes that are C<CANCELED>, C<ACCEPTED>, or C<DECLINED> | ||
| 51 | show up in lists for only 30 days after entering that state After that | ||
| 52 | they are deleted. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Action => Str | ||
| 58 | |||
| 59 | The type of handshake, indicating what action occurs when the recipient | ||
| 60 | accepts the handshake. The following handshake types are supported: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | B<INVITE>: This type of handshake represents a request to join an | ||
| 67 | organization. It is always sent from the management account to only | ||
| 68 | non-member accounts. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | B<ENABLE_ALL_FEATURES>: This type of handshake represents a request to | ||
| 73 | enable all features in an organization. It is always sent from the | ||
| 74 | management account to only I<invited> member accounts. Created accounts | ||
| 75 | do not receive this because those accounts were created by the | ||
| 76 | organization's management account and approval is inferred. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | B<APPROVE_ALL_FEATURES>: This type of handshake is sent from the | ||
| 81 | Organizations service when all member accounts have approved the | ||
| 82 | C<ENABLE_ALL_FEATURES> invitation. It is sent only to the management | ||
| 83 | account and signals the master that it can finalize the process to | ||
| 84 | enable all features. | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 Arn => Str | ||
| 91 | |||
| 92 | The Amazon Resource Name (ARN) of a handshake. | ||
| 93 | |||
| 94 | For more information about ARNs in Organizations, see ARN Formats | ||
| 95 | Supported by Organizations | ||
| 96 | (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) | ||
| 97 | in the I<AWS Service Authorization Reference>. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 ExpirationTimestamp => Str | ||
| 101 | |||
| 102 | The date and time that the handshake expires. If the recipient of the | ||
| 103 | handshake request fails to respond before the specified date and time, | ||
| 104 | the handshake becomes inactive and is no longer valid. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Id => Str | ||
| 108 | |||
| 109 | The unique identifier (ID) of a handshake. The originating account | ||
| 110 | creates the ID when it initiates the handshake. | ||
| 111 | |||
| 112 | The regex pattern (http://wikipedia.org/wiki/regex) for handshake ID | ||
| 113 | string requires "h-" followed by from 8 to 32 lowercase letters or | ||
| 114 | digits. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 Parties => ArrayRef[L<Paws::Organizations::HandshakeParty>] | ||
| 118 | |||
| 119 | Information about the two accounts that are participating in the | ||
| 120 | handshake. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 RequestedTimestamp => Str | ||
| 124 | |||
| 125 | The date and time that the handshake request was made. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 Resources => ArrayRef[L<Paws::Organizations::HandshakeResource>] | ||
| 129 | |||
| 130 | Additional information that is needed to process the handshake. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 State => Str | ||
| 134 | |||
| 135 | The current state of the handshake. Use the state to trace the flow of | ||
| 136 | the handshake through the process from its creation to its acceptance. | ||
| 137 | The meaning of each of the valid values is as follows: | ||
| 138 | |||
| 139 | =over | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | B<REQUESTED>: This handshake was sent to multiple recipients | ||
| 144 | (applicable to only some handshake types) and not all recipients have | ||
| 145 | responded yet. The request stays in this state until all recipients | ||
| 146 | respond. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | B<OPEN>: This handshake was sent to multiple recipients (applicable to | ||
| 151 | only some policy types) and all recipients have responded, allowing the | ||
| 152 | originator to complete the handshake action. | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | B<CANCELED>: This handshake is no longer active because it was canceled | ||
| 157 | by the originating account. | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | B<ACCEPTED>: This handshake is complete because it has been accepted by | ||
| 162 | the recipient. | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | B<DECLINED>: This handshake is no longer active because it was declined | ||
| 167 | by the recipient account. | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | B<EXPIRED>: This handshake is no longer active because the originator | ||
| 172 | did not receive a response of any kind from the recipient before the | ||
| 173 | expiration time (15 days). | ||
| 174 | |||
| 175 | =back | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head1 SEE ALSO | ||
| 181 | |||
| 182 | This class forms part of L<Paws>, describing an object used in L<Paws::Organizations> | ||
| 183 | |||
| 184 | =head1 BUGS and CONTRIBUTIONS | ||
| 185 | |||
| 186 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 187 | |||
| 188 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 189 | |||
| 190 | =cut | ||
| 191 |