GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::Organizations::Handshake(3) User Contributed Perl Documentation Paws::Organizations::Handshake(3)

Paws::Organizations::Handshake

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Organizations::Handshake object:

  $service_obj->Method(Att1 => { Action => $value, ..., State => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Organizations::Handshake object:

  $result = $service_obj->Method(...);
  $result->Att1->Action

Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.

Note: Handshakes that are "CANCELED", "ACCEPTED", or "DECLINED" show up in lists for only 30 days after entering that state After that they are deleted.

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.
  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.
  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the "ENABLE_ALL_FEATURES" invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) in the AWS Service Authorization Reference.

The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

The regex pattern (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

Information about the two accounts that are participating in the handshake.

The date and time that the handshake request was made.

Additional information that is needed to process the handshake.

The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

  • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
  • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
  • CANCELED: This handshake is no longer active because it was canceled by the originating account.
  • ACCEPTED: This handshake is complete because it has been accepted by the recipient.
  • DECLINED: This handshake is no longer active because it was declined by the recipient account.
  • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

This class forms part of Paws, describing an object used in Paws::Organizations

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.