Skip to content

Handshake

Source code in docs_src/capo_organizations/types/handshake.py
class Handshake(TypedDict, closed=True):
    id: NotRequired["capo_organizations.types.handshake_id.HandshakeId"]
    """<p>ID for the handshake.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.</p>"""
    arn: NotRequired["capo_organizations.types.handshake_arn.HandshakeArn"]
    """<p>Amazon Resource Name (ARN) for the handshake.</p> <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"""
    parties: NotRequired["capo_organizations.types.handshake_parties.HandshakeParties"]
    """<p>An array of <code>HandshakeParty</code> objects. Contains details for participant in a handshake.</p>"""
    state: NotRequired["capo_organizations.types.handshake_state.HandshakeState"]
    """<p>Current state for the handshake.</p> <ul> <li> <p> <b>REQUESTED</b>: Handshake awaiting a response from the recipient.</p> </li> <li> <p> <b>OPEN</b>: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.</p> </li> <li> <p> <b>CANCELED</b>: Handshake canceled by the sender.</p> </li> <li> <p> <b>ACCEPTED</b>: Handshake accepted by the recipient.</p> </li> <li> <p> <b>DECLINED</b>: Handshake declined by the recipient.</p> </li> <li> <p> <b>EXPIRED</b>: Handshake has expired.</p> </li> </ul>"""
    requested_timestamp: NotRequired["capo_organizations.types.timestamp.Timestamp"]
    """<p>Timestamp when the handshake request was made.</p>"""
    expiration_timestamp: NotRequired["capo_organizations.types.timestamp.Timestamp"]
    """<p>Timestamp when the handshake expires.</p>"""
    action: NotRequired["capo_organizations.types.action_type.ActionType"]
    """<p>The type of handshake:</p> <ul> <li> <p> <b>INVITE</b>: Handshake sent to a standalone account requesting that it to join the sender's organization.</p> </li> <li> <p> <b>ENABLE_ALL_FEATURES</b>: Handshake sent to invited member accounts to enable all features for the organization.</p> </li> <li> <p> <b>APPROVE_ALL_FEATURES</b>: Handshake sent to the management account when all invited member accounts have approved to enable all features.</p> </li> <li> <p> <b>TRANSFER_RESPONSIBILITY</b>: Handshake sent to another organization's management account requesting that it designate the sender with the specified responsibilities for recipient's organization.</p> </li> </ul>"""
    resources: NotRequired[
        "capo_organizations.types.handshake_resources.HandshakeResources"
    ]
    """<p>An array of <code>HandshakeResource</code> objects. When needed, contains additional details for a handshake. For example, the email address for the sender.</p>"""

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.