Handshake
¶
Source code in docs_src/capo_organizations/types/handshake.py
action
instance-attribute
¶
action: NotRequired[ActionType]
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.
arn
instance-attribute
¶
arn: NotRequired[HandshakeArn]
Amazon Resource Name (ARN) for the handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
expiration_timestamp
instance-attribute
¶
expiration_timestamp: NotRequired[Timestamp]
Timestamp when the handshake expires.
id
instance-attribute
¶
id: NotRequired[HandshakeId]
ID for the handshake.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
parties
instance-attribute
¶
parties: NotRequired[HandshakeParties]
An array of HandshakeParty objects. Contains details for participant in a handshake.
requested_timestamp
instance-attribute
¶
requested_timestamp: NotRequired[Timestamp]
Timestamp when the handshake request was made.
resources
instance-attribute
¶
resources: NotRequired[HandshakeResources]
An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.
state
instance-attribute
¶
state: NotRequired[HandshakeState]
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.