Handshake
Contains details for a handshake. A handshake is the secure exchange of information between two AWS accounts: a sender and a recipient.
Note: Handshakes that are CANCELED,
ACCEPTED, DECLINED, or EXPIRED show up in
lists for only 30 days after entering that state After that they are deleted.
Contents
- Action
-
The type of handshake:
-
INVITE: Handshake sent to a standalone account requesting that it to join the sender's organization.
-
ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.
-
APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.
-
TRANSFER_RESPONSIBILITY: Handshake sent to another organization's management account requesting that it designate the sender with the specified responsibilities for recipient's organization.
Type: String
Valid Values:
INVITE | ENABLE_ALL_FEATURES | APPROVE_ALL_FEATURES | ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE | TRANSFER_RESPONSIBILITYRequired: No
-
- Arn
-
Amazon Resource Name (ARN) for the handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.
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
-
Timestamp when the handshake expires.
Type: Timestamp
Required: No
- Id
-
ID for the handshake.
The regex pattern
for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. Type: String
Length Constraints: Maximum length of 34.
Pattern:
^h-[0-9a-z]{8,32}$Required: No
- Parties
-
An array of
HandshakePartyobjects. Contains details for participant in a handshake.Type: Array of HandshakeParty objects
Required: No
- RequestedTimestamp
-
Timestamp when the handshake request was made.
Type: Timestamp
Required: No
- Resources
-
An array of
HandshakeResourceobjects. When needed, contains additional details for a handshake. For example, the email address for the sender.Type: Array of HandshakeResource objects
Required: No
- State
-
Current state for the handshake.
-
REQUESTED: Handshake awaiting a response from the recipient.
-
OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.
-
CANCELED: Handshake canceled by the sender.
-
ACCEPTED: Handshake accepted by the recipient.
-
DECLINED: Handshake declined by the recipient.
-
EXPIRED: Handshake has expired.
Type: String
Valid Values:
REQUESTED | OPEN | CANCELED | ACCEPTED | DECLINED | EXPIREDRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: