Menu
AWS Organizations API Reference
API Reference (API Version 2016-11-28)

Handshake

Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master 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.

Contents

Action

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 master 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 master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master 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 master account and signals the master that it can finalize the process to enable all features.

Type: String

Valid Values: INVITE | ENABLE_ALL_FEATURES | APPROVE_ALL_FEATURES | ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE

Required: No

Arn

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

Type: String

Pattern: ^arn:aws:organizations::\d{12}:handshake\/o-[a-z0-9]{10,32}\/[a-z_]{1,32}\/h-[0-9a-z]{8,32}

Required: No

ExpirationTimestamp

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.

Type: Timestamp

Required: No

Id

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

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

Type: String

Pattern: ^h-[0-9a-z]{8,32}$

Required: No

Parties

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

Type: Array of HandshakeParty objects

Required: No

RequestedTimestamp

The date and time that the handshake request was made.

Type: Timestamp

Required: No

Resources

Additional information that is needed to process the handshake.

Type: Array of HandshakeResource objects

Required: No

State

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).

Type: String

Valid Values: REQUESTED | OPEN | CANCELED | ACCEPTED | DECLINED | EXPIRED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: